summaryrefslogtreecommitdiffstats
path: root/doc/generated/variables.gen
Commit message (Collapse)AuthorAgeFilesLines
* [ci skip] update generated filesWilliam Deegan2024-11-161-69/+71
|
* Tweak User Guide environment descriptionsMats Wichmann2024-09-211-11/+46
| | | | | | | | | | | | Reword/clarify the section on `AllowSubstExceptions` and the sidebar on Python dictionaries. Add an additonal piece to `env.Replace`. Also, some entity replacements, and more explicit `id` tags added to `section` elements. One unittest change to make sure passing a dict to `env.Replace` works. Signed-off-by: Mats Wichmann <mats@linux.com>
* Additinal tweaks for $VSWHERE [skip appveyor]Mats Wichmann2024-07-031-14/+15
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* Further tweak $VSWHERE, also $MSVC_VERSION [skip appveyor]Mats Wichmann2024-07-031-37/+42
| | | | | | Apply the same note to $MSVC_VERSION about discovery, for consistency. Signed-off-by: Mats Wichmann <mats@linux.com>
* Update $VSWHERE description. [skip appveyor]Mats Wichmann2024-07-011-56/+102
| | | | | | | | Requested wordsmithing on the VSWHERE construction variable. Per request, dropped msvc.py from the github/win32 skip list. Signed-off-by: Mats Wichmann <mats@linux.com>
* Allow a Variable to not be substitutedMats Wichmann2024-06-031-2/+2
| | | | | | | | | | New parameter do_subst added to the variables Add method, if false indicates the variable value should not be substituted by the Variables logic. The default is True. Fixes #4241. Signed-off-by: Mats Wichmann <mats@linux.com>
* Tweak some things about Command() docsMats Wichmann2024-05-221-2/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Adjust the description of the Command function (and builder entry), mainly to try out new terminology. We've said it's not really a builder, but it feels better to me to admit it is *exactly* a builder call, just not to one of the existing named builders. So the term introduced is "anonymous builder". Changes in docstring for Command, too, plus a little tweak to kwarg processing. This change actually started with reformatting some examples in the manpage, which used Command, which used the chdir argument which didn't seem to be mentioned in the description of how to use Command, which lists four keyword args and says all the rest are treated as construction variable settings (not true for chdir, which isn't one of the four). That led to thinking about rewording. The original code reformatting changes, no longer directly related to the current change subject, are left in just because they seem low burden, tough could back them out if it makes reviewing to hard. A couple of other small tweaks: * some places referred to a section named "File and Directory Nodes" but it's no longer named that. Actual links to the section updated fine when it was renamed, but in Environment.xml, which produces shared content, you can't use manpage-specific links, so the _textual_ references needed updating. * the code example for a warning was moved inside the warning - the effect on output is just an indent to match the warning. * Configure used both terms "custom checks" and "custom tests", now only the former; plus a link reference added. Signed-off-by: Mats Wichmann <mats@linux.com>
* Regenerated docs for 4.7.0 releaseWilliam Deegan2024-03-181-0/+16
|
* fixed a few typos and changed all references to c++ project file to be MSVC ↵William Deegan2024-03-011-110/+119
| | | | (entity) project file
* Regenerated docs for 4.6.0 release.William Deegan2023-11-191-109/+252
|
* Add arm64 to the MSVS supported architectures list for VS2017 and later to ↵Joseph Brill2023-03-191-2/+2
| | | | | | be consistent with the current documentation of MSVS_ARCH. Update the documentation for HOST_ARCH.
* Regenerated docs for 4.5.0 release.William Deegan2023-03-051-265/+685
|
* Updated autogenerated doc filesWilliam Deegan2022-07-301-7/+111
|
* Add msvc script error global policy and construction variable. Move msvc not ↵Joseph Brill2022-07-051-0/+126
| | | | found policy and msvc script error policy to Policy.py. Rework vcvars bugfix handling for SxS toolset 14.28. Add method to return msvc toolsets. Add experimental function to return msvc version and msvc toolset version given a version specification (proxy for selection). Add API.py to manage symbols imported in vc.py. Update documentation.
* Additional validation for MSVC_SDK_VERSION and MSVC_SPECTRE_LIBS. Adjust ↵Joseph Brill2022-06-281-2/+15
| | | | documentation. Add additional exceptions for SDK version not found, toolset version not found, and spectre libraries not found. Add data structure for platform type.
* Rework SxS toolset version support and vcvars bug fix handling. Update ↵Joseph Brill2022-06-271-14/+25
| | | | MSVC_TOOLSET_VERSION documentation.
* Set global lxml etree XSLT maximum traversal depth. Update generated ↵Joseph Brill2022-06-261-35/+68
| | | | documentation artifacts.
* Minor documentation update based on stress tests [ci skip]Joseph Brill2022-06-251-4/+6
|
* Documentation updates [ci skip]Joseph Brill2022-06-241-82/+117
|
* Construction variable documentation additions and modifications.Joseph Brill2022-06-231-11/+547
|
* Doc: mention Fortran "dialects"Mats Wichmann2022-06-151-145/+436
| | | | | | | | | | | | | | | | | | | Add to the existing manpage section on Fortran system-specific behavior notes that SCons provides construction environment sets for six "dialects", so that each can be individually tuned based on the file suffix. The PR author considers this system to be of dubious utlity - it only has any real effect in a project with files of many different suffixes where each suffix indicates different handling, within a single build. Since such builds might theoretically exist (there must have been some reason this setup was designed), just try to document what there is. Related in a proximate way only (i.e. next item in manpage), the note on cygwin+Python is amended to also mention msys2. Fixes #4173 Signed-off-by: Mats Wichmann <mats@linux.com>
* Updated docs for 4.2.0 releaseWilliam Deegan2021-11-161-221/+185
|
* Update docs for HOST_OS, TEMPFILE and Split [skip travis] [skip appveyor]Mats Wichmann2021-09-271-81/+134
| | | | | | | | | | | | | | | | | | | | | | The HOST_ARCH/TARGET_ARCH functions have been defined in two places, generic and Windows, these are consolidated into one, leaving a comment in the msvc.xml file to show where that version went to. HOST_OS/TARGET_OS also got some tweaks - this was in line with these now being set by default for all platforms. The $TERMPFILE construction var was not defined; added and the whole family had docs updated. A small tweak to Split wording. References to Python changed to entity references (there are still more of these to change). lambda as an entity reference is not correct (generated docs show the symbol, but Python does not use the lambda symbol to refer to lambda expressions). Signed-off-by: Mats Wichmann <mats@linux.com>
* Define HOST_OS and HOST_ARCH in the environment for all platformsAaron Franke2021-08-291-2/+0
| | | | Before this commit, these were only defined for Win32 and OS/2
* updated docsWilliam Deegan2021-07-241-0/+2
|
* Regenerated docs for 4.2.0 release.William Deegan2021-07-241-25/+52
|
* Fix formatting on ninja example command blockWilliam Deegan2021-07-101-10/+15
|
* Fix broken markup, regenerate filesWilliam Deegan2021-07-091-5/+5
|
* Updates to docs to indicate experimental statusWilliam Deegan2021-07-081-44/+45
|
* Fix ninja.xml syntax errorWilliam Deegan2021-06-011-18/+171
|
* Update generated docs. They were broken [skip appveyor][skip travis]William Deegan2021-04-181-167/+220
|
* update example to simplify map_filename and relocate emitter to after that ↵William Deegan2021-02-261-1/+1
| | | | variable is set as it uses it
* Some small doc fiddles [ci skip]Mats Wichmann2021-01-211-2/+2
| | | | | | | | | | | | | | | | * Use os.environ.copy() in examples - better not to get the Python proxy class that is os.environ, and instead a real dict. * Fix spelling on a python dict method: set_default -> setdefault * Update some wording on prepending in the user guide (where it still said "append to the beginning") * Change the rather oblique note in the recently modified section on Append of values to CPPDEFINES with something more explicit. * And, modify the sphinx config to get the version from SCons rather than hardcoding. Fixes #3867 Signed-off-by: Mats Wichmann <mats@linux.com>
* Regenerated docs for 4.1.0 releaseWilliam Deegan2021-01-191-0/+17
|
* [ci skip]Updated generated docs, Updated docsWilliam Deegan2021-01-151-83/+100
|
* Regenerated docs for 4.0.1 ReleaseWilliam Deegan2020-07-171-0/+9
|
* Updated generated doc files for 4.0.0William Deegan2020-07-041-23/+43
|
* [appveyor skip] fix ulink vs link xml syntaxWilliam Deegan2020-06-231-27/+27
|
* Updated generated doc files and user manual.Dirk Baechle2020-06-201-667/+667
|
* Documentation updates in perparation for 4.0 [ci skip]Mats Wichmann2020-06-101-16/+39
| | | | | | | | | | | | | * Switch API docs to readthedocs theme * Add links in manpage SEE ALSO to external websites. These are not just live, but also listed out (Linux manpages won't have the hyperlinks) * Links use docbook5 xlink:href instead of deprecated (claimed to be removed, but apparently not) ulink syntax * Comment out manpage Examples section, and leave a pointer to scons-cookbook.readthedocs.io instead * Regenerate everything, mainly to pick up compilation_db stuff. Signed-off-by: Mats Wichmann <mats@linux.com>
* classes no longer explicitly inherit from objectMats Wichmann2020-05-241-1/+1
| | | | | | In Python3 this is the default. Signed-off-by: Mats Wichmann <mats@linux.com>
* [WIP] adjust docbuild for moved src [ci skip]Mats Wichmann2020-05-101-2818/+3574
| | | | | | | src/engine/SCons moved to SCons, affects wired in paths in documentation, and doc building scripts Signed-off-by: Mats Wichmann <mats@linux.com>
* Update manpage intro section [ci skip]Mats Wichmann2019-12-201-11/+0
| | | | | | | | | Side effect: added an entry to scons.mod for the sconscript function (it didn't have one since the name itself was already in use). Change the type of a few entities. Those changes don't have a content effect, just a presentation effect. Signed-off-by: Mats Wichmann <mats@linux.com>
* Regenerated docs for 3.1.2 releaseWilliam Deegan2019-12-171-1464/+2086
|
* Merge branch 'master' into py3-doctasksWilliam Deegan2019-12-101-24/+43
|\
| * [PR 3475] update docs/generated [ci skip]Mats Wichmann2019-11-161-46/+74
| | | | | | | | | | | | | | | | | | | | There's debated about whether the generated should be checked in at all; without an answer to that, they've fallen far enough out of sync that it becomes harder to use "git diff" as a spot-check that nothing strange is happening due to any given doc change. This should resync them to current. Signed-off-by: Mats Wichmann <mats@linux.com>
* | [PR 3443] regen all generated files [ci skip]Mats Wichmann2019-12-051-2112/+1499
|/ | | | | | | | Checking in all the examples generated on Ubuntu, which is the default "build platform", to pick up changes caused by a Py3 build. Signed-off-by: Mats Wichmann <mats@linux.com>
* manpage: clarify that tools=[list] overrides [ci skip]Mats Wichmann2019-09-071-11/+11
| | | | | | | | | Also some formatting tweaks, and a couple of typos. The description of the default tool now lists some of what that may include. Signed-off-by: Mats Wichmann <mats@linux.com>
* Clean up D compiler pagesMats Wichmann2019-08-271-377/+105
| | | | | | | | | | | | | | | | | Manpage duplicated (triplicated, actually) tons of construction variables because they were defined in each of the three possible names for the D compiler. Someone already started a DCommon.xml, this just finishes off the job of moving them there; the individual compiler-name docs now do not define any construction vars. THe ProgramAllAtOnce builder had the same problem, and got the same treatment. Note: lots of the cvars don't actually define the term. I don't use D so I'm not proposing any changes at this time, but it would be simple enough to merge in some simple wording if someone thinks it's important enough. Signed-off-by: Mats Wichmann <mats@linux.com>
* Regenerated docs for 3.1.1 release.William Deegan2019-08-081-12/+12
|
generated by cgit v0.12 at 2025-08-27 20:17:48 (GMT)