-
Bug
-
Resolution: Fixed
-
P3
-
9
-
b89
Issue | Fix Version | Assignee | Priority | Status | Resolution | Resolved In Build |
---|---|---|---|---|---|---|
JDK-8142565 | emb-9 | Magnus Ihse Bursie | P3 | Resolved | Fixed | team |
JDK-8292987 | openjdk8u352 | Andrew Hughes | P3 | Resolved | Fixed | b05 |
The build documentation is currently available in README-build.html. The problem with having the build instructions in html format is two-fold:
1) It is hard to read from a terminal
2) It is unnecessary difficult to modify
At least 2) means that it is an extra threshold to get over, in order to update or rewrite the build documentation.
Instead, we should have the documentation in markdown format, which is easy to read in a console even in source format, and is easy to modify. From this source format, a html version can easily be generated.
1) It is hard to read from a terminal
2) It is unnecessary difficult to modify
At least 2) means that it is an extra threshold to get over, in order to update or rewrite the build documentation.
Instead, we should have the documentation in markdown format, which is easy to read in a console even in source format, and is easy to modify. From this source format, a html version can easily be generated.
- backported by
-
JDK-8142565 Generate README-build.html from markdown
-
- Resolved
-
-
JDK-8292987 Generate README-build.html from markdown
-
- Resolved
-