summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Updated autogenerated doc filesWilliam Deegan2022-07-3013-23/+137
|
* Fix Sphinx config file error [skip appveyor]Mats Wichmann2022-07-301-1/+1
| | | | | | | Sphinx is now complaining about not defining a language being illegal. Defined to 'en'. Signed-off-by: Mats Wichmann <mats@linux.com>
* Merge pull request #4196 from mwichmann/doc/dedent-compdbWilliam Deegan2022-07-251-61/+53
|\ | | | | Dedent some examples in userguide
| * Dedent some examples in userguide [ci skip]Mats Wichmann2022-07-251-61/+53
| | | | | | | | | | | | | | | | | | | | | | | | The compilation DB examples in the User Guide are indented with the rest of the text (possibly auto-formatting by an editor), while the scons_example and programlisting XML elements respect formatting, so they should actually be dedented. Example code which is not to be displayed (just used to drive the example generation) don't matter so they were left alone this time. Signed-off-by: Mats Wichmann <mats@linux.com>
* | Merge pull request #4174 from jcbrill/jbrill-msvc-batchargsWilliam Deegan2022-07-254-88/+857
|\ \ | |/ |/| MSVC enhancement to add all remaining msvc batch file command-line options as SCons variables
| * Add msvc script error global policy and construction variable. Move msvc not ↵Joseph Brill2022-07-052-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.
| * Merge branch 'master' into jbrill-msvc-batchargsJoseph Brill2022-06-261-191/+232
| |\
| * | 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
| | |
* | | Merge pull request #4183 from mwichmann/maint/lex_yaccWilliam Deegan2022-07-191-1/+0
|\ \ \ | | | | | | | | Improvements to lex and yacc tools
| * | | Improvements to lex and yacc toolsMats Wichmann2022-06-301-1/+0
| | |/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The mocked tools mylex.py and myyacc.py now understand the file-generation options, and generate a dummy file with predictable contents, for checking. This allows more testing of the path through the SCons support for these two without needing live commands. New tests added which invoke the file-generation options, and make sure the extra files are created, and that SCons detects and tracks the added targets. Work is done in a subdirectory, which exposes some existing known inconsistent behavior (the regular generated file goes in the subdir per the LEXCOM and YACCOM generated line, while the ones generated from commandline options go in the topdir) - but we're going to allow that behavior to continue for backwards compat. Same fix applied to yacc tool that PR #4168 did for lex - do subst_list() instead of subst() to preserve spaces in paths. That fix left the lex tool unable to pass the new test, as it could not see the individual arguments in the FLAGS variable, which was solved by indexing into the subst'd list so we can iterate over the args again. Test and tool cleanup; add DefaultEnvironment calls, etc. Note this mentions, but does not address the problem described in issue 4154. Signed-off-by: Mats Wichmann <mats@linux.com>
* | | [manpage] more on execution environment [skip appveyor]Mats Wichmann2022-07-181-15/+32
|/ / | | | | | | | | | | Reworded a bit. Signed-off-by: Mats Wichmann <mats@linux.com>
* | Merge pull request #4167 from mwichmann/doc/builder-tweaksWilliam Deegan2022-06-251-175/+209
|\ \ | | | | | | doc: tweaked Builder intro section in manpage
| * | minor edits plus adding a warning about using chdirWilliam Deegan2022-06-251-5/+22
| | |
| * | A few more tweaks in Builder Methods intro [skip appveyor]Mats Wichmann2022-06-201-26/+24
| | | | | | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * | Tweaked Builder intro section in manpage [skip appveyor]Mats Wichmann2022-06-201-162/+181
| |/ | | | | | | | | | | | | | | | | Mostly wording changes, some rearranging/grouping. Makes sure the three documented recognized kwargs are listed together, followed by the statement that unrecognized kwargs are consvar overrides. Signed-off-by: Mats Wichmann <mats@linux.com>
* | Minor edits. Link to Action Objects instead of just referencing it, and ↵William Deegan2022-06-251-1/+1
| | | | | | | | removed extraneous '(see)'
* | Doc wordsmithing - actions [skip appveyor]Mats Wichmann2022-06-181-16/+23
|/ | | | | | | | Tweak the wording of Execute, PRINT_CMD_LINE_FUNC (whose excample did not match what the wording said it did) and the Action Objects section. Signed-off-by: Mats Wichmann <mats@linux.com>
* Doc: mention Fortran "dialects"Mats Wichmann2022-06-156-409/+824
| | | | | | | | | | | | | | | | | | | 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>
* [ci skip] Added blurb about ninja restarting the scons daemon if it detects ↵William Deegan2022-06-031-2/+7
| | | | need to regenerate the build.ninja
* Merge branch 'master' into ninja_always_executeWilliam Deegan2022-06-022-64/+161
|\
| * Merge pull request #4157 from mwichmann/doc/swigWilliam Deegan2022-05-251-1/+1
| |\ | | | | | | Tweak the swig tool documentation
| | * Tweak the swig tool documentation [skip appveyor]Mats Wichmann2022-05-231-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Minor changes: the spelled-out name of the tool as used in SCons docs was not the same as the manpage uses, and it was repeated a bunch of times spelled out for no good reason. Just turned it all into uses of &swig; entity. A bit of tweaking of some of the entries. SWIGCXXFILESUFFIX had a copy-paste error, it referred to CFILESUFFIX instead of CXXFILESUFFIX. Signed-off-by: Mats Wichmann <mats@linux.com>
| * | Add to description of Node Objects [skip appveyor]Mats Wichmann2022-05-242-63/+160
| |/ | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* | Updated ninja docs in users guilde.William Deegan2022-06-021-13/+41
|/
* Merge branch 'master' into msvc/cachefixWilliam Deegan2022-05-155-56/+74
|\
| * docs: update parseconfig, parseflags, mergeflagsMats Wichmann2022-05-043-48/+51
| | | | | | | | | | | | | | | | | | | | | | | | Docstrings Environment (inc. .backtick) also lightly updated. Functional change: the function to be called by ParseConfig is now passed the *unique* flag, previously omitted (if the default MergeFlags was used, it still picked up this flag but a user-supplied function did not). Added a unit test for user-supplied function. Signed-off-by: Mats Wichmann <mats@linux.com>
| * Uguide: fix a typo of environment [ci skip]Mats Wichmann2022-04-191-1/+1
| | | | | | | | | | | | Spotted by @night-ripper on Discord Signed-off-by: Mats Wichmann <mats@linux.com>
| * Merge pull request #4124 from mwichmann/doc/generate-more-infoWilliam Deegan2022-03-311-7/+22
| |\ | | | | | | Add a bit more info to tool "generate" function doc
| | * Add a bit more info to tool "generate" function [skip appveyor]Mats Wichmann2022-03-251-7/+22
| | | | | | | | | | | | | | | | | | | | | | | | | | | Seemed useful to actually record the suggestion that tool modules should not unconditionally set the values of all contstruction variables - some could be considered user-settable and if so, existing values should be respected. Signed-off-by: Mats Wichmann <mats@linux.com>
* | | Merge branch 'master' into msvc/cachefixWilliam Deegan2022-03-293-268/+326
|\ \ \ | |/ /
| * | Separated just the CheckMember() checker from yuzhicang's PR #4100, changed ↵William Deegan2022-03-211-1/+29
| |/ | | | | | | code to have same return values as rest of checkers, updated test to work with that.
| * Merge pull request #4119 from mwichmann/doc/uguide-buildersWilliam Deegan2022-03-202-85/+85
| |\ | | | | | | Guide: update Writing Builders chapter
| | * Guide: update Writing Builders chapter [skip appveyor]Mats Wichmann2022-03-192-85/+85
| | | | | | | | | | | | | | | | | | | | | | | | | | | Use entities more consistently. Reword a few things. Text implied that site_init.py needs to be manually imported, adjusted wording not to say so. Signed-off-by: Mats Wichmann <mats@linux.com>
| * | man: rearrange the variable substitution section [skip appveyor]Mats Wichmann2022-03-151-188/+210
| |/ | | | | | | | | | | | | | | | | | | | | The idea is to get the syntactial elements presented in a relatively concise order, in the existing text you have to hunt quite a bit for certain parts. Some portions reworded. The mention of $$ as a sbust escape (PR 4091) is also added to the env.subst entry. Signed-off-by: Mats Wichmann <mats@linux.com>
| * Merge branch 'master' into doc/var-subst-escapeWilliam Deegan2022-03-096-207/+269
| |\
| * | man: drop some extra wording [ci skip]Mats Wichmann2022-01-291-1/+1
| | | | | | | | | | | | | | | | | | | | | An extra stanza was added "or other text" that didn't really make sense in context, remove it again. Signed-off-by: Mats Wichmann <mats@linux.com>
| * | Man: mention $$ a subst escape [skip appveyor]Mats Wichmann2022-01-281-23/+33
| | | | | | | | | | | | | | | | | | | | | Some rewordings elsewhere in Variable Substitution section - mainly to a variable that's a function. Signed-off-by: Mats Wichmann <mats@linux.com>
* | | Tweak the MSVC environment vars cacheMats Wichmann2022-03-081-1/+1
| |/ |/| | | | | | | | | | | | | | | | | | | - Now performs a sanity check: if the retrieved tools path does not exist, consider the entry invalid so it will be recomputed. - The dictionary key, which is the name of a batch file, is computed a bit differently: the dashes are left off if there are no arguments. - The cachefile is changed to have a .json suffix, for better recognition on Windows systems. Signed-off-by: Mats Wichmann <mats@linux.com>
* | Updates to User Guide: 22/Caching [skip appveyor]Mats Wichmann2022-03-022-95/+120
| | | | | | | | | | | | | | | | | | | | | | | | Use entities. Adopt the "derived-file cache" terminology used elsewhere instead of the former wording "shared cache". Also added entity references for content/build sigs to manpage, as well as some other entity fiddling. CacheDir entry now mentions SCons doesn't do cache maintenance. Signed-off-by: Mats Wichmann <mats@linux.com>
* | Merge pull request #4099 from mwichmann/doc/guide-dependsWilliam Deegan2022-03-022-66/+69
|\ \ | | | | | | Updates to User Guide: 6/Dependencies
| * | Use entity for content signature [ci skip]Mats Wichmann2022-02-102-9/+10
| | | | | | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * | Fix typo Note -> Not [ci skip]Mats Wichmann2022-02-091-1/+1
| | | | | | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * | Updates to User Guide: 6/DependenciesMats Wichmann2022-02-091-63/+65
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Removed most references to md5 and tried to make the terminology used a bit more consistent. Added some markup - refernced functions now hyperlinked on first mention of each section. Signed-off-by: Mats Wichmann <mats@linux.com>
* | | Ninja docs (#4105): address some review commentsMats Wichmann2022-02-281-1/+1
| | | | | | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* | | Tweaks to ninja docs [skip appveyor]Mats Wichmann2022-02-241-29/+65
|/ / | | | | | | | | | | | | | | | | Rewrite of the intro in the user guide. Otherwise, just markup, formatting, wording tweaks, bigger example of how to install ninja. Signed-off-by: Mats Wichmann <mats@linux.com>
generated by cgit v0.12 at 2025-02-16 17:58:46 (GMT)