Build man pages into per-section subdirectories #4890
Merged
Conversation
This file contains hidden or 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
We currently build our manual pages and the HTML versions of
them into a single "man" directory, which results in release
package archives on GitHub that contain all of these files
interleaved with each other in that one directory.
When we build Linux RPM and Debian packages, though, the man
pages are installed into their conventional locations under
/usr/share/man/man{1,5}. (The HTML versions are not included
at all.)
For those downloading the release package archives and not using
the RPM or Debian packages, we can improve their experience by
placing the roff man pages into "man1" and "man5" subdirectories
corresponding to their respective sections of the manual, and the
HTML versions of the pages into an "html" subdirectory.
bk2204
approved these changes
Feb 28, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
We currently build our manual pages and the HTML versions of them into a single
mandirectory, which results in release package archives on GitHub that contain all of these files interleaved with each other in that one directory.When we build Linux RPM and Debian packages, though, the man pages are installed into their conventional locations under
/usr/share/man/man{1,5}. (The HTML versions are not included at all.)For those downloading the release package archives and not using the RPM or Debian packages, we can improve their experience by placing the roff man pages into
man/man1andman/man5subdirectories corresponding to their respective sections of the manual, and the HTML versions of the pages into aman/htmlsubdirectory.(A test run of the release Actions workflow shows all release package types being built up to the point where certification would normally occur, which then fails, but I believe that's expected for a forked repo's run of this workflow. The Linux package builds in particular appears to have succeeded in populating their manual pages as expected.)