man: emit .TP for each flag entry to generate linkable anchors - #3521
Open
ShivangiRay wants to merge 1 commit into
Open
man: emit .TP for each flag entry to generate linkable anchors#3521ShivangiRay wants to merge 1 commit into
ShivangiRay wants to merge 1 commit into
Conversation
mandoc(1) (and by extension HTML renderers built on it, e.g. man.archlinux.org) generates per-entry anchor IDs from .TP/.IP tagged paragraphs, but not from plain bold text. ripgrep's man page currently documents each flag as bold text wrapped in .RS/.RE, so individual options can't be linked to directly. Emitting .TP before each flag's tag line gives every option a stable, linkable anchor (e.g. rg.1.html#context), matching the convention already used by fd's man page, which is what this issue's reporter pointed to as a working example. Verified against the real generated rg.1 (15.2.0 release) by applying this transformation and rendering with mandoc: per-option anchors go from 0 to 104, all pre-existing rendered text is byte-for-byte unchanged (including the --color flag's nested bullet list, the one case that needed the original .RS 4/.RE body wrapper preserved), and no new mandoc lint warnings are introduced. Fixes BurntSushi#3243
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
mandoc(1) (and by extension HTML renderers built on it, e.g. man.archlinux.org) generates per-entry anchor IDs from .TP/.IP tagged paragraphs, but not from plain bold text. ripgrep's man page currently documents each flag as bold text wrapped in .RS/.RE, so individual options can't be linked to directly.
Emitting .TP before each flag's tag line gives every option a stable, linkable anchor (e.g. rg.1.html#context), matching the convention already used by fd's man page, which is what this issue's reporter pointed to as a working example.
Verified against the real generated rg.1 (15.2.0 release) by applying this transformation and rendering with mandoc: per-option anchors go from 0 to 104, all pre-existing rendered text is byte-for-byte unchanged (including the --color flag's nested bullet list, the one case that needed the original .RS 4/.RE body wrapper preserved), and no new mandoc lint warnings are introduced.
Fixes #3243