summaryrefslogtreecommitdiffstats
path: root/SCons/Script/SConscript.xml
Commit message (Collapse)AuthorAgeFilesLines
* 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