summaryrefslogtreecommitdiffstats
path: root/SCons/Script/Main.xml
Commit message (Collapse)AuthorAgeFilesLines
* *.xml: Add miscellaneous language improvementsAlex Thiessen2024-11-151-1/+1
|
* *.xml: Add missing commasAlex Thiessen2024-11-151-1/+1
|
* *.xml: Fix obvious typos etc.Alex Thiessen2024-11-151-2/+2
|
* Doc: use consistent repeated-args syntax [skip appveyor]Mats Wichmann2024-08-031-10/+16
| | | | | | | | | For now, want to keep the "key=value, ..." form for Functions/Method signatures instead of using **kwargs, since that terminology hasn't been introduced. May switch signatures later, but if so, do them all, let's not be piecemeal. Signed-off-by: Mats Wichmann <mats@linux.com>
* Standardize license header on in-use doc files [skip appveyor]Mats Wichmann2024-06-251-2/+3
| | | | | | There are no code changes. Signed-off-by: Mats Wichmann <mats@linux.com>
* AddOption now recognizes "settable" optionMats Wichmann2024-06-171-12/+28
| | | | | | | | | | | | | | | | AddOption and the internal add_local_option which AddOption calls now recognize a "settable" keyword argument to indicate a project-added option can also be modified using SetOption. There was a TODO in SCons/Script/SConsOptions.py about removing three hardcoded ninja options in the "settable" list once this change was made. When that was done it turned out one test failed, because it called the SetOption before the ninja tool was initialized. Logic reordered in the test, but this is a thing to watch out for. Closes #3983. Signed-off-by: Mats Wichmann <mats@linux.com>
* doc: update Pseudo description and moreMats Wichmann2024-02-091-17/+24
| | | | | | | | | | | | The Pseudo manpage entry is updated to be more descriptive. Since they were near neighbors in Environment.py, it and the three functions Precious, Repository and Requires received minor docstring changes there; Precious and Requires also got a minor tweak to the manpage entry (mainly to clarify allowable argument types and list return value). Signed-off-by: Mats Wichmann <mats@linux.com>
* Added docsWilliam Deegan2023-06-051-0/+17
|
* Minor cleanup ValidateOptions doc/code/testMats Wichmann2023-04-141-56/+71
| | | | | | | | | | | | Some nearby things in Main.py as well: - docstrings polished a bit, minor linting - move the list of predefined SConstruct file names into a constant defined at the top of the file, so it's a little less hidden, in the unlikely case of future changes. Manpage text and example revised a bit. Signed-off-by: Mats Wichmann <mats@linux.com>
* man: add a "New in..." to ValidateOPtions [skip appveyor]Mats Wichmann2023-03-031-3/+3
| | | | | | | The new ValidateOptions had a :versionadded: in the docstring, but just noticed the actual manpage entry didn't have similar. Signed-off-by: Mats Wichmann <mats@linux.com>
* Manpage tweaking [skip appveyor]Mats Wichmann2022-12-061-11/+9
| | | | | | | | | | | | | * Reworded the section on --experimental - separate when the two current features were made available, and when --experimental itself was added. * Reworded in GetOption * Changed tags on a few options * Use entity forms in more places (Python -> &Python;, SConscript -> &SConscript; etc.) * Make changed/added notifications more consistent with what Sphinx produces for the API docs (:versionadded: and :versionchanged: markup) Signed-off-by: Mats Wichmann <mats@linux.com>
* doc and docstring updatesWilliam Deegan2022-08-171-1/+1
|
* rework the docsWilliam Deegan2022-08-171-14/+27
|
* Address doc and docstring feedback from mwichmannWilliam Deegan2022-08-161-6/+10
|
* Added throw_exception parameter to ValidateOptions() which allows you to ↵William Deegan2022-08-151-0/+21
| | | | select either have ValidateOptions() issue error message and exit,or throw an exception and then you can handle it your own way. per dmoody's sugguestion
* add language with instructions what to do if options added by tools are ↵William Deegan2022-08-151-3/+8
| | | | being flagged as undefined. Per mwichmann's feedback
* address comments by mwichmannWilliam Deegan2022-08-151-2/+2
|
* Add ValidateOption() API which validates that all command line options are ↵William Deegan2022-08-131-0/+20
| | | | either SCons specified or specifie by AddOption calls. It will error out if there are any unknown options. Resolves Issue #4187
* Update the documentation for GetOptionMats Wichmann2021-05-111-285/+277
| | | | | | | | | Since working on Get/SetOption anyway via tests, update the documentation as well. GetOption now has a table (instead of a spread out list) to match SetOption, and the available vars are all listed, as well as a note on AddOption'd vars. Signed-off-by: Mats Wichmann <mats@linux.com>
* Enable SetOption for implicit_deps*Mats Wichmann2021-05-081-145/+137
| | | | | | The SetOption table in the docs is reformatted for easier editing. Signed-off-by: Mats Wichmann <mats@linux.com>
* Make sure SetOption list is up to dateMats Wichmann2021-05-081-6/+56
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* Add docs for --experimental switchWilliam Deegan2021-04-091-1/+14
|
* Update some copyright strings and drop __revision__ [skip appveyor]Mats Wichmann2020-09-231-1/+1
| | | | | | | | | | | | | | | | | | Touches the first and second levels of SCons (except SCons.Tool), not tests or docs which remain TODO. Make sure docstring is first non-comment content, eliminate cases where docstring is set elsewhere but assigns to __doc__ - this approach of course worked inside Python, but confuses various tools. Some module-level docstrings modified a bit, in particular the convention of having the name of the module as the first line is dropped, replaced by a summary description going there instead - this improves the look in the API Docs, which otherwise display something like: SCons.Foo - SCons.Foo Signed-off-by: Mats Wichmann <mats@linux.com>
* Merge pull request #3758 from mwichmann/GetSet-optsWilliam Deegan2020-09-191-110/+122
|\ | | | | Align SetOption doc with settable options list
| * [PR #3758] expand on SetOption limitations [skip appvyor]Mats Wichmann2020-07-301-1/+5
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * [PR #3758] be more explicit about syncing SetOption list [ci skip]Mats Wichmann2020-07-291-1/+2
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * Align SetOption doc with settable options list. [skip appveyor]Mats Wichmann2020-07-271-110/+117
| | | | | | | | | | | | | | | | List is recast into a table for readability. Comments in both places remind to keep lists in sync. Signed-off-by: Mats Wichmann <mats@linux.com>
* | Reject abbreviations of AddOption options.Mats Wichmann2020-08-231-2/+2
|/ | | | | | | If a cmdline option is left over, and looks like an abbreviation of an AddOption'd option, raise an error. Signed-off-by: Mats Wichmann <mats@linux.com>
* Updates to shared docs [ci skip]Mats Wichmann2020-05-301-120/+141
| | | | | | | | | | Mostly update markup to more "standard" markup conventions. There are some substantive wording changes to CacheDir descriptions in Environment, and to the AddOption/Help descriptions in Main and SConscript files. Signed-off-by: Mats Wichmann <mats@linux.com>
* classes no longer explicitly inherit from objectMats Wichmann2020-05-241-1/+3
| | | | | | In Python3 this is the default. Signed-off-by: Mats Wichmann <mats@linux.com>
* [ci skip] Add note that AddOption('no_progress') is new as of 4.0.0William Deegan2020-05-111-0/+1
|
* Merge pull request #3459 from dmoody256/patch-1William Deegan2020-05-111-0/+12
|\ | | | | Add no_progress (-Q) as set-able option
| * Merge remote-tracking branch 'origin/master' into patch-1Daniel Moody2020-05-061-0/+12
| |
* | [WIP] adjust docbuild for moved src [ci skip]Mats Wichmann2020-05-101-5/+5
|/ | | | | | | src/engine/SCons moved to SCons, affects wired in paths in documentation, and doc building scripts Signed-off-by: Mats Wichmann <mats@linux.com>
* Reorganize the repo. Moved src/engine/SCons to ./SCons to be more in line ↵William Deegan2020-05-061-0/+853
with current python packaging practices
generated by cgit v0.12 at 2026-01-13 21:17:07 (GMT)