Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8344056

Use markdown format for man pages

XMLWordPrintable

    • b25

      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.

            ihse Magnus Ihse Bursie
            iris Iris Clark
            Votes:
            1 Vote for this issue
            Watchers:
            7 Start watching this issue

              Created:
              Updated:
              Resolved: