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.

I think this means the one-true-master copy of a man page is now the public .md 
file.
All contributors can now change and improve man pages, and would be expected to 
make necessary man page updates when making other changes.
(Which is great, I just didn't see it being explicitly said.)

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

PR Comment: https://git.openjdk.org/jdk/pull/22081#issuecomment-2474701337

Reply via email to