RFR: 8344056: Use markdown format for man pages

Magnus Ihse Bursie ihse at openjdk.org
Wed Nov 13 18:11:11 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.

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

Commit messages:
 - Replace tabs with spaces
 - Remove logic for copying .1 man pages
 - Insert GPL header
 - Add missing Windows man pages for kerberos and accessibility
 - Replace generated troff man pages with markdown version

Changes: https://git.openjdk.org/jdk/pull/22081/files
  Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=22081&range=00
  Issue: https://bugs.openjdk.org/browse/JDK-8344056
  Stats: 41443 lines in 65 files changed: 18943 ins; 22500 del; 0 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