Add notes to Get/SetOption manpage entries#4865
Open
mwichmann wants to merge 2 commits into
Open
Conversation
Options are stored in an internal data structure defined by the optparse module, and despite the comments that you can deduce the type from the command-line option doc, it's not always obvious. Added an annotation to the Notes column in an attempt to be more explicit. Signed-off-by: Mats Wichmann <mats@linux.com>
In the GetOption table, all the corresponding options pointed to the same entry, but -D and -U should point to their own entries. Signed-off-by: Mats Wichmann <mats@linux.com>
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.
Options are stored in an internal data structure defined by the
optparsemodule, and despite the comments that you can deduce the type from the command-line option doc, it's not always obvious. Added an annotation to the Notes column in an attempt to be more explicit.One option value which defaulted to
Nonenow defaults to0- that'sclimb_up, which holds a code indicating which of the "hunt for SConstruct according to this algorithm" options was selected - there was no reason to useNonehere.Note that there are four option values that could have a value of
None, where this is not included in the new table info. The option-defining code could be updated for these four to saydefault=""instead ofdefault=Nonewithout apparently affecting operation at all, but I didn't include such a change in this PR (yet?).cache_debugdefaults toNone, falsy""would work fine:diskcheckdefaults toNone, falsy""would work fine:profile_filedefaults toNone, falsy""would work fine:taskmastertrace_filedefaults toNone, falsy""would work fine:And one option that legitimately needs an additional sentinel, so this one was added to the doc table:
site_dirdefaults toNone. In this case, we do want to distinguish between the case where there's been no option affecting this, and the case where someone asked for site dir reading to be disabled, so a single empty string wouldn't do in this case.This is a doc-only change.
Contributor Checklist:
CHANGES.txtandRELEASE.txt(and read theREADME.rst).