On Wed, 13 Nov 2024 17:05:25 GMT, Magnus Ihse Bursie <i...@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. So glad to see progress here! https://github.com/openjdk/jdk/blob/1484153c1a092cefc20270b35aa1e508280843a4/test/langtools/jdk/javadoc/tool/CheckManPageOptions.java#L141 should read `return findRootDir().resolve("src/jdk.javadoc/share/man/javadoc.md");` now. ------------- PR Comment: https://git.openjdk.org/jdk/pull/22081#issuecomment-2474760888
