DocBook manpage improvements #1142
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Generating a manpage from Asciidoctor's DocBook output requires the refentrytitle, manvolnum, refname, and refpurpose elements to be present to work correctly.
In DocBook, the proper tag for the synopsis section of a manpage is "refsynopsisdiv".
|
Merged as b71c342. I made a few minor changes.
Thanks! I checked the output using fopub and it looks great! |
Definitely for historical reasons :) |
|
Actually, you can see that we're still missing compatibility with AsciiDoc Python in this area. I probably didn't complete it because it wasn't a priority at the time, but if Asciidoctor is going to be used to generate output for the git man pages, then it obviously becomes a priority :) https://github.com/asciidoc/asciidoc/blob/master/docbook45.conf#L620 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The DocBook code for generating manpages contained a few bugs. Probably for historical reasons, DocBook requires manpages (refentry documents) to use
refsectioninstead ofsection(andrefsect1instead ofsect1, etc.). Also, the block element holding the synopsis section should berefsynopsisdiv.Finally, man pages require some additional metadata in the
refmetaandrefnamedivelements immediately after the main document'sinfoblock. Without these, the DocBook stylesheets won't be able to determine the manpage name and section, and will try to output to a file called.1.This is the minimal amount of changes required on the Asciidoctor side to build Git using Asciidoctor instead of AsciiDoc. I will be sending a patch series to the Git list to fix up the Git side of things.