Integrated: 8344056: Use markdown format for man pages

Magnus Ihse Bursie ihse at openjdk.org
Mon Nov 18 09:29:52 UTC 2024


On Wed, 13 Nov 2024 17:05:25 GMT, Magnus Ihse Bursie <ihse at openjdk.org> wrote:

> 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.

This pull request has now been integrated.

Changeset: 475feb06
Author:    Magnus Ihse Bursie <ihse at openjdk.org>
URL:       https://git.openjdk.org/jdk/commit/475feb064bb6b9dfd34fc52762e3e0ab825254ec
Stats:     41386 lines in 66 files changed: 18876 ins; 22500 del; 10 mod

8344056: Use markdown format for man pages

Reviewed-by: cstein, iris, dholmes

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

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


More information about the core-libs-dev mailing list