Minor doc fixes for linking#4849
Merged
bdbaddog merged 2 commits intoSCons:masterfrom May 5, 2026
Merged
Conversation
bdbaddog
reviewed
May 5, 2026
| Adds <parameter>text</parameter> to the help message shown when | ||
| &scons; is called with the | ||
| <option>-h</option> or <option>--help</option> | ||
| <link linkend="opt-"><option>-h</option> or <option>--help</option></link> |
Collaborator
Author
There was a problem hiding this comment.
Unsurprisingly, yes.
Collaborator
Author
There was a problem hiding this comment.
Hmmm, I wrote a followup, which seems to have vanished into the ether. It actually needs to be opt-help because of the way the option entries are targged. Updated.
Some of the linker-related entities needed some rewording; others needed a cleanup where emphasized references were turned into live links to entities elsewhere. Most of the remaining references to command-line options were turned into live links (the addition of anchors for those is relatively recent, they didn't originally use live-linking). Signed-off-by: Mats Wichmann <mats@linux.com>
A reference to opt-help was missing the "help" part. Signed-off-by: Mats Wichmann <mats@linux.com>
mwichmann
force-pushed
the
doc/linking-and-entities
branch
from
46487e1 to
0e1c820
Compare
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
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.
Some of the linker-related entities needed some rewording; others needed a cleanup where emphasized references were turned into live links to entities elsewhere.
Most of the remaining references to command-line options were turned into live links (the addition of anchors for those is relatively recent, they didn't originally use live-linking).
This is a doc-only change.
Contributor Checklist:
CHANGES.txtandRELEASE.txt(and read theREADME.rst).