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

Christian Stein cstein at openjdk.org
Fri Nov 15 15:04:51 UTC 2024


On Fri, 15 Nov 2024 14:46:33 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.
>
> Magnus Ihse Bursie has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Fix regexes in CheckManPageOptions

test/langtools/jdk/javadoc/tool/CheckManPageOptions.java line 277:

> 275: 
> 276:         // In the defining areas, option names are represented as follows:
> 277:         //      `OPTION` or `OPTION`

`OPTION` or `OPTION` ... where's the difference?

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

PR Review Comment: https://git.openjdk.org/jdk/pull/22081#discussion_r1843959156


More information about the core-libs-dev mailing list