Emit a NAME section properly formatted for whatis parsing #124
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
Paragraph tags following headers are not necessary and confuse semantic parsers such as lexgrog. Signed-off-by: Cory Snider <csnider@mirantis.com>
This is the required format for man-page parsers across the ecosystem to successfuly parse out whatis information. Signed-off-by: Cory Snider <csnider@mirantis.com>
cpuguy83
approved these changes
Sep 12, 2024
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.
Suppress
.PPtags immediately following headers, and transform the first hyphen in theNAMEsection text to\-so that generated man-pages follow the conventions required for proper indexing.This does not affect the typeset output of man pages.