-
-
Notifications
You must be signed in to change notification settings - Fork 316
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Don't lose local-options help text #3686
Labels
args_and_options
options processing, arguments, get/setoption and their relationshiop
Comments
mwichmann
added
the
args_and_options
options processing, arguments, get/setoption and their relationshiop
label
Mar 20, 2021
This looks like it's about the same thing as #2356, which already had dupes. |
Commented in #2356 on current prototype. That does not fix the last bullet in the complaint list - a banner for Variables, nor does it yet address the idea of being able to add help text for Aliases and have them appear in the Help output, which has been mentioned but doesn't yet have an issue. |
mwichmann
added a commit
to mwichmann/scons
that referenced
this issue
Aug 1, 2023
An additional keyword argument, "local_only", is now recorgnized by Help(). If true, and "append" is True, then only project-defined help messages are saved into the help text. That is, save help added by calls to AddOption, but not SCons' own help, which is added a different way. Fixes SCons#2356 Fixes SCons#3686 Signed-off-by: Mats Wichmann <mats@linux.com>
mwichmann
added a commit
to mwichmann/scons
that referenced
this issue
Aug 1, 2023
An additional keyword argument, "local_only", is now recorgnized by Help(). If true, and "append" is True, then only project-defined help messages are saved into the help text. That is, save help added by calls to AddOption, but not SCons' own help, which is added a different way. Fixes SCons#2356 Fixes SCons#3686 Signed-off-by: Mats Wichmann <mats@linux.com>
3 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
This is related to other recent activity (issue on help, plus doc updating activities) but wanted to document the case specifically rather than hijacking a different issue.
Help message handling is logically awkward:
-H
. It also provides the initial text used for the local help, which is displayed with the-h
option, which is the same as--help
.AddOption
calls add to the local help, but not to the SCons help.Help
either rewrites the local help, or appends to it, depending on value ofappend
kwargHelp
appends to local help, regardless of value ofappend
Variables
object methodGenerateHelpText
requires anenv
to operate on butVariables
is not environment-specific. Why is this?Complaints:
Help
call did not append, the help text fromAddOption
is lost: it's dropped from local help, and was not added to SCons help.Help(msg, append=bool)
: caller-suppliedappend
honored on first call, ignored otherwise; default value ofappend
appears to flip, first call defaults non-appending, subsequent calls default appendingAddOption
) and local variables (aka: "help for project-specific command line usage"). It isn't, unless full SCons help is retained in the local help as well. That can well be too noisy for a project that adds a number of its own options.AddOption
calls gets a section banner (Local Options) but command-line variables do not.The text was updated successfully, but these errors were encountered: