man pages: Reformat to support NAME heading for proper whatis processing #212
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
bluca
reviewed
Aug 9, 2022
bluca
reviewed
Aug 9, 2022
bluca
approved these changes
Aug 9, 2022
The 'whatis' utility expects a man page to start with a NAME section with the name and a short description of the utility. Add some regex hackery to make sure our exported man pages conform to this format. For details, see: https://www.mit.edu/afs.new/sipb/project/debathena/lintian/www/tags/manpage-has-bad-whatis-entry.html Reported-by: Luca Boccassi <bluca@debian.org> Signed-off-by: Toke Høiland-Jørgensen <toke@redhat.com>
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 'whatis' utility expects a man page to start with a NAME section with
the name and a short description of the utility. Add some regex hackery to
make sure our exported man pages conform to this format. For details, see:
https://www.mit.edu/afs.new/sipb/project/debathena/lintian/www/tags/manpage-has-bad-whatis-entry.html
Reported-by: Luca Boccassi bluca@debian.org
Signed-off-by: Toke Høiland-Jørgensen toke@redhat.com