Fix #2330: Escape angle brackets in man page output#2357
Open
rodionsteshenko wants to merge 1 commit intospf13:mainfrom
Open
Fix #2330: Escape angle brackets in man page output#2357rodionsteshenko wants to merge 1 commit intospf13:mainfrom
rodionsteshenko wants to merge 1 commit intospf13:mainfrom
Conversation
Angle brackets in command Usage, Short, Long, and flag Usage strings were stripped by md2man which interpreted them as HTML tags. This caused placeholders like [<remote>:]<instance> to render as [:] in man pages. Fix: escape < and > with backslashes before passing to md2man. Added TestGenManAngleBracketsPreserved to verify the fix.
|
|
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
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.
Problem
Angle brackets in command
Use,Short,Long, and flagUsagestrings were stripped by md2man, which interpreted them as HTML tags. This caused placeholders like[<remote>:]<instance>to render as[:]in man pages.Reported in #2330 by @stgraber (Incus project).
Fix
Added
escapeAngleBrackets()which replaces<with\\<and>with\\>before the markdown is passed to md2man. Applied to:cmd.UseLine()in SYNOPSIScmd.Shortin NAMEflag.Usagein OPTIONSTest
Added
TestGenManAngleBracketsPreservedthat creates a command with angle-bracketed placeholders in Use, Short, and Long, generates a man page, and verifies the angle brackets survive in the rendered output.transfer [:] [:](all placeholder names stripped)<remote>,<source>,<dest>Tested locally on macOS ARM (Apple Silicon). Full test suite passes.