Skip to content

User Guide: remove duplicate option table - #4915

Merged
bdbaddog merged 1 commit into
SCons:masterfrom
mwichmann:doc/user-option-table
Oct 5, 2026
Merged

bdbaddog merged 1 commit into
SCons:masterfrom
mwichmann:doc/user-option-table

Conversation

@mwichmann

Copy link
Copy Markdown
Collaborator

Chapter 10 of the user guide had a table of gettable options, which basically duplicates the information in the documention for GetOption and SetOption. It had gone out of date. To reduce version skew and extra work, the table is dropped in favor of pointers to GetOption and SetOption - since those appear in an appendix of the User Guide, there's no problem with cross-document links.

Doc-only change.

Contributor Checklist:

  • I have created a new test or updated the unit tests to cover the new/changed functionality.
  • I have updated CHANGES.txt and RELEASE.txt (and read the README.rst).
  • I have updated the appropriate documentation

Chapter 10 of the user guide had a table of gettable options,
which basically duplicates the information in the documention
for GetOption and SetOption. It had gone out of date.
To reduce version skew and extra work, the table is dropped
in favor of pointers to GetOption and SetOption - since those
are in an appendix of the User Guide, there's no problem with
cross-document links.

Signed-off-by: Mats Wichmann <mats@linux.com>
@mwichmann mwichmann added this to the NextRelease milestone Oct 2, 2026
@bdbaddog
bdbaddog merged commit 39f243e into SCons:master Oct 5, 2026
10 of 12 checks passed
@mwichmann
mwichmann deleted the doc/user-option-table branch October 5, 2026 13:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants