summaryrefslogtreecommitdiff
path: root/doc/generated
Commit message (Collapse)AuthorAgeFilesLines
* Regenerated docs for 4.5.2 release.William Deegan2023-03-211-3/+3
|
* Regenerated docs for 4.5.1 releaseWilliam Deegan2023-03-061-3/+3
|
* Regenerated docs for 4.5.0 release.William Deegan2023-03-0511-742/+1399
|
* rework the docsWilliam Deegan2022-08-162-16/+33
|
* Added throw_exception parameter to ValidateOptions() which allows you to ↵William Deegan2022-08-152-5/+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-141-3/+7
| | | | being flagged as undefined. Per mwichmann's feedback
* updates based on mwichmann's comments on the PRWilliam Deegan2022-08-142-5/+5
|
* Add ValidateOption() API which validates that all command line options are ↵William Deegan2022-08-134-4/+26
| | | | either SCons specified or specifie by AddOption calls. It will error out if there are any unknown options. Resolves Issue #4187
* fix a couple typosFlaviu Tamas2022-08-131-3/+3
|
* Fix -fsanitize flag handlingFlaviu Tamas2022-08-131-0/+1
| | | | | | | These parameters need to be passed to both the compiler and the linker, otherwise lots of "undefined reference to `__asan_stack_malloc_0'" errors get emitted at link time, since the appropriate library is not linked in.
* Updated autogenerated doc filesWilliam Deegan2022-07-3013-23/+137
|
* Add msvc script error global policy and construction variable. Move msvc not ↵Joseph Brill2022-07-042-0/+128
| | | | 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-264-69/+105
| | | | 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-232-11/+555
|
* Doc: mention Fortran "dialects"Mats Wichmann2022-06-155-359/+691
| | | | | | | | | | | | | | | | | | | 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>
* Add some info to User Guide on #/paths [skip appveyor]Mats Wichmann2022-01-071-0/+5
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* 4.3.0 updates4.3.0William Deegan2021-11-171-2/+2
|
* updated CHANGES.txt and RELEASE.txt for releaseWilliam Deegan2021-11-161-1/+1
|
* Updated docs for 4.2.0 releaseWilliam Deegan2021-11-1610-301/+356
|
* Update docs for HOST_OS, TEMPFILE and Split [skip travis] [skip appveyor]Mats Wichmann2021-09-273-111/+171
| | | | | | | | | | | | | | | | | | | | | | 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-281-2/+0
| | | | Before this commit, these were only defined for Win32 and OS/2
* Regenerated docs for X.Y.Z release.William Deegan2021-07-311-1/+1
|
* updated docsWilliam Deegan2021-07-233-6/+8
|
* Regenerated docs for 4.2.0 release.William Deegan2021-07-233-27/+54
|
* Fix formatting on ninja example command blockWilliam Deegan2021-07-097-72/+106
|
* Merge branch 'master' into ninja-generationWilliam Deegan2021-07-091-14/+20
|\
| * Update env.Tool behavior and docMats Wichmann2021-05-231-16/+22
| | | | | | | | | | | | | | Review comments suggested for consistency env.Tool should also return the Tool instance. Signed-off-by: Mats Wichmann <mats@linux.com>
* | Fix broken markup, regenerate filesWilliam Deegan2021-07-094-9/+9
| |
* | Updates to docs to indicate experimental statusWilliam Deegan2021-07-076-66/+85
| |
* | Address mwichmann's comments on PR. Mostly doc and a few import related code ↵William Deegan2021-06-018-377/+409
| | | | | | | | changes
* | Fix ninja.xml syntax errorWilliam Deegan2021-06-017-20/+265
|/
* Update generated docs. They were broken [skip appveyor][skip travis]William Deegan2021-04-1812-447/+655
|
* update example to simplify map_filename and relocate emitter to after that ↵William Deegan2021-02-265-10/+10
| | | | variable is set as it uses it
* [PR #3877] fix some broken examples from initial commit [ci skip]Mats Wichmann2021-02-164-24/+0
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* Adding-emitter example for User Guide [ci skip]Mats Wichmann2021-01-311-0/+13
| | | | | | | | | | | | | | | | | | Add an example on adding an emitter to an existing builder, based on a mailing-list discussion with Jeremy Elson. Also: * Try to model "best practice" by changing instances of hand-modifying env['ENV']['PATH'] in examples to using AppendENVPath function. * Fixed a couple of Py2-style print statements. * Tweaked markup on a couple of instances of site_scons. * Black-formatted examples in the two userguide sections that were otherwise modified. * Dropped old cons doc content which was included as a big comment at the fromt of builders-writing.xml. Signed-off-by: Mats Wichmann <mats@linux.com>
* 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-196-6/+25
|
* [ci skip]Updated generated docs, Updated docsWilliam Deegan2021-01-1512-418/+507
|
* Adjust CompilationDatase documentation [skip appveyor]Mats Wichmann2020-12-232-0/+8
| | | | | | | | | Try to be a bit more descriptive about compilation databases. Two of the User Guide examples now use the scons_examples style to show a little more what happens. Fixes #3845. Signed-off-by: Mats Wichmann <mats@linux.com>
* Tweaks to variant dir documentation [skip appveyor]Mats Wichmann2020-09-211-0/+2
| | | | | | | | | | | | | | | | | | | Manpage/shared VariantDir function wording tries to make more clear that build happens in the variant. Other tweaking. User guide variant description similarly updated. A (worded) example of why one might want variants is added. Formerly separate chapter doc/user/variants.xml is now included as a section in the previous chapter. An additional example is enabled (was in the file but commented out), which some introductiory wording. The introduction to the other sample in the file is also built up slightly. Dropped embedded comments that were the old Cons documentation for these topics. Signed-off-by: Mats Wichmann <mats@linux.com>
* Merge pull request #3791 from mwichmann/sideeffectWilliam Deegan2020-09-192-1/+5
|\ | | | | Include SideEffect section into the UserGuide
| * Include SideEffect section into the UserGuide [skip appveyor]Mats Wichmann2020-09-042-1/+5
| | | | | | | | | | | | | | Existing written doc, but was not included - now added to the Miscellaneous chapter. Some rewriting. Signed-off-by: Mats Wichmann <mats@linux.com>
* | More clarification and fixes on Variables [skip appveyor]Mats Wichmann2020-09-177-8/+14
|/ | | | | | | | | | | | | | | | | | | | | | Add note to manpage that Variables names should not conflict with existing constructions variables. Fix a broken User Guide example which was hitting a Py2/Py3 transition - was displaying "Unknown variables: dict_keys(['NOT_KNOWN'])" instead of "Unknown variables: NOT_KNOWN" Added a User Guide note on how to make sure a Variable is actually supplied, if that's what you want (making the default an invalid value). This is supported by an additional output of an existing example (it's not a new example, just called a different way). Slightly built up the explanation of UnknownVariables not being usable until variables object has been passed to an env. Examples reformatted using Black, which changed some line numbers in example outputs. Signed-off-by: Mats Wichmann <mats@linux.com>
* and fix a "thinko" in new userguide example [skip appveyor]Mats Wichmann2020-08-281-1/+1
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* Updated docs on Actions for output controlMats Wichmann2020-08-281-0/+3
| | | | | | | | | | | | | Manpage now mentions specifically generating your own Action object in order to control the output string. Calls out using None as the command-output specifier to avoid output: Action(foo, None) and Action(foo, cmdstr=None), as well Userguide got a mention of using the action kwarg for readability and an example showing creating the Action for Command manually to set the output string. Signed-off-by: Mats Wichmann <mats@linux.com>
* [PR #3752] guide: update consvar setting after review [skip appveyor]Mats Wichmann2020-07-232-0/+9
| | | | | | | | | | | | | | | | Review comments noted that there was perhaps more assumptions about Python knowledge than warranted, added some things to address that, including an intro to dictionaries. Markup changes in environment chapter, plus more wording tweaks. Filled out an example of of overriding when calling a builder, and added a note on when that is not sufficient, and separate envs are needed. Dropped a python2 paragraph. Signed-off-by: Mats Wichmann <mats@linux.com>
View Lorry Controller Status