summaryrefslogtreecommitdiffstats
path: root/SCons/Script/SConscript.xml
Commit message (Collapse)AuthorAgeFilesLines
* *.xml: Fix obvious typos etc.Alex Thiessen2024-11-151-1/+1
|
* Bump SCons "added" version to 4.8 [skip appveyor]Mats Wichmann2024-07-071-1/+1
| | | | | | | | Two additions in the cycle since 4.7.0 had documentation annotations that they were added in 4.7.1. Update to 4.8.0. One of those changes didn't have an annotation in the code. 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>
* Minor editsWilliam Deegan2024-05-041-0/+1
|
* Implement `GetSConsVersion` static methodThaddeus Crews2024-04-151-0/+12
|
* SConscript() doc: minor tweaks after review [skip appveyor]Mats Wichmann2023-09-221-4/+4
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* Updates for Export/Import doc [skip appveyor]Mats Wichmann2023-09-191-45/+81
| | | | | | | | Mention mutable objects - if an sconscript imports a previously exported variable, it is the same object, so changes propagete. Some wording tweaks in SConscript function. Signed-off-by: Mats Wichmann <mats@linux.com>
* Merge branch 'master' into feature/local-helpWilliam Deegan2023-08-241-7/+10
|\
| * Change the default to error on missing SConscriptMats Wichmann2023-08-061-7/+10
| | | | | | | | | | | | | | | | | | | | | | This completes a change begun in 3.0.2, when the behavior changed from "skip silently" to "skip but issue a warning"; that behavior was marked deprecated in 3.1. Use must_exist=False to get the old "skip silently" behavior. Fixes #3958 Signed-off-by: Mats Wichmann <mats@linux.com>
* | Add ability to save "local" help onlyMats Wichmann2023-08-011-13/+26
|/ | | | | | | | | | | | | 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 #2356 Fixes #3686 Signed-off-by: Mats Wichmann <mats@linux.com>
* doc: change five functions to appear global-onlyMats Wichmann2022-09-141-4/+4
| | | | | | | | | | | | | The five functions EnsureSConsVersion, EnsurePythonVersion, Exit, GetLaunchDir, SConscriptChdir were listed as both global and environment functions, but they do nothing in the context of an environment, so marked in the xml as "global". This only changes the presentation in the manpage & userguide appendix, not the behavior. Minor tweaks in the code around SConscriptChdir - actually use a bool True/False instead of 0/1, and added a couple of type annotations. Signed-off-by: Mats Wichmann <mats@linux.com>
* SConscript doc tweaks per #4150 review comments [skip appveyor]Mats Wichmann2022-05-261-2/+3
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* A little more work on Sconscript() documentation [skip appveyor]Mats Wichmann2022-05-251-22/+21
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* Try to improve variantdir docs [skip appveyor]Mats Wichmann2022-05-251-30/+26
| | | | | | | Reorder some bits, add some explantaions, include example of passing different environments to subsidiary SConscript. Signed-off-by: Mats Wichmann <mats@linux.com>
* Make target selection a subsection in manpage [skip travis] [skipMats Wichmann2021-03-301-37/+31
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | appveyor] The selection of targets to build is important, and referred to often. Seems it would be helpful to have it as its own section, with an xml id tag so it can be referenced via link. To make that happen, it's moved to the end of introduction, otherwise have to also make subsections for other stuff that followed it, or it would look like those parts belonged to Target Selection. To make it easier to read the target selection section, id and link references are added to options, so the options described can be followed via a click. These are both introductory bits of work: nothing links to the new subsection yet, and only some of the references to command line options are linked to the new option anchors. A note added to -c and -n to further clarify only builder targets are affected, and to -n to clarify that the determination is necessarily imperfect. The --hash-chunksize option is documented now (by taking the text formerly in md5-chunksize and updating slightly), and the work related to the change to hash options is marked with a version-specific change notice (4.2). Edits are made to clarify the behavior of Default to address issue #2839, which is that any alias used should already be defined. Added to this PR because it gave the opportunity to add a reference to the newly-named section (not a hyperlink, since scons-function definitions also appear in the User Guide). Closes #2839. Signed-off-by: Mats Wichmann <mats@linux.com>
* 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>
* Updates to shared docs [ci skip]Mats Wichmann2020-05-301-12/+14
| | | | | | | | | | 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>
* [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/+608
with current python packaging practices
generated by cgit v0.12 at 2025-08-27 20:18:28 (GMT)