RFR: 8344056: Use markdown format for man pages [v2]

Magnus Ihse Bursie ihse at openjdk.org
Thu Nov 14 11:11:54 UTC 2024


> Currently, the man pages are stored as troff (a text format) in the open repo, and a content-wise identical copy is stored as markdown (another text format) in the closed repo.
> 
> Since markdown is preferred to troff in terms of editing, we make changes to the man pages in markdown and then convert it to troff.
> 
> This closed-markdown to open-troff processing needs to be done manually by an Oracle engineer. This is done regularly at the start and end of a new release cycle, adding to the burden of creating a new release. It is also done (if any of the reviewers knows about the process) whenever an Oracle engineer updates a man page. If a community contributor changes the behavior of a tool, an Oracle engineer needs to change the documentation for them, since they cannot do it themselves.

Magnus Ihse Bursie has updated the pull request incrementally with two additional commits since the last revision:

 - Fix CheckManPageOptions test
 - Remove classpath exception

-------------

Changes:
  - all: https://git.openjdk.org/jdk/pull/22081/files
  - new: https://git.openjdk.org/jdk/pull/22081/files/ffb41ba0..a8d4ea50

Webrevs:
 - full: https://webrevs.openjdk.org/?repo=jdk&pr=22081&range=01
 - incr: https://webrevs.openjdk.org/?repo=jdk&pr=22081&range=00-01

  Stats: 106 lines in 36 files changed: 0 ins; 70 del; 36 mod
  Patch: https://git.openjdk.org/jdk/pull/22081.diff
  Fetch: git fetch https://git.openjdk.org/jdk.git pull/22081/head:pull/22081

PR: https://git.openjdk.org/jdk/pull/22081


More information about the core-libs-dev mailing list