summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* [PR #3877] fix some broken examples from initial commit [ci skip]Mats Wichmann2021-02-167-26/+13
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* Adding-emitter example for User Guide [ci skip]Mats Wichmann2021-01-315-206/+270
| | | | | | | | | | | | | | | | | | 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-214-24/+26
| | | | | | | | | | | | | | | | * 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>
* update API doc version to 4.1.0 and add some more dependencies on the api ↵4.1.0William Deegan2021-01-191-2/+2
| | | | target to include the sphinx config files
* Updated release notes and copyright info for 4.1.0 ReleaseWilliam Deegan2021-01-192-10/+10
|
* Regenerated docs for 4.1.0 releaseWilliam Deegan2021-01-196-6/+25
|
* [ci skip] update CPPDEFINES to use tuples for -Doff_t=intWilliam Deegan2021-01-192-10/+12
|
* Merge pull request #3863 from mwichmann/sconf-guideWilliam Deegan2021-01-193-11/+15
|\ | | | | | | | | UGuide: fix two erroneous uses of Append I'll fix up a couple items post merge.
| * Update doc uses of CCFLAGS to CPPDEFINES [ci skip]Mats Wichmann2021-01-163-11/+15
| | | | | | | | | | | | | | | | After discussion, it seemed like we should set a proper example, so the Append and Prepend examples that used *FLAGS to set a -Dstring value now use CPPDEFINES (without the -D). Signed-off-by: Mats Wichmann <mats@linux.com>
| * UGuide: fix two erroneous uses of Append [ci skip]Mats Wichmann2021-01-131-2/+2
| | | | | | | | | | | | | | | | | | | | In the SConf chapter, one use was not as a keyword argument, while the other set a "-DVAR=value" form to append to CPPDEFINES, which aren't supposed to be given the prefix - that's the whole reason for CPPDEFINES. Both changed to CCFLAGS, to match other usage in the chapter. Signed-off-by: Mats Wichmann <mats@linux.com>
* | Merge pull request #3844 from mwichmann/man-sconscriptsWilliam Deegan2021-01-161-35/+105
|\ \ | | | | | | Build up manpage information on sconscript files.
| * | [PR #3844] change a spelling per review comment [ci skip]Mats Wichmann2020-12-211-3/+3
| | | | | | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * | [PR #3844] adjust man wordings per review [ski appveyor]Mats Wichmann2020-12-191-22/+23
| | | | | | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * | Build up manpage information on sconscript files.Mats Wichmann2020-12-171-32/+101
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Tweaked introductory section with a few more details. Added a new subsection to begin the Confguration File Reference section, called Configuration Files, mainly as a better home for the information on alternate SConstruct names, which seemed a distraction at the top of the file, as well as to introduce the concept that sconscript files are independent of each other, which does not appear to be explicitly stated (although you could gather the information by reading some Function entries). Also provides quick links to other Config File subsections - manpage is hard to navigate as it's so long. Signed-off-by: Mats Wichmann <mats@linux.com>
* | | [ci skip]Updated generated docs, Updated docsWilliam Deegan2021-01-1512-418/+507
| |/ |/|
* | [PR #3847] Make tests pass again on Travis [skip appveyor]Mats Wichmann2021-01-091-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | With the Travis build switched to install the ldc compiler through a snap, scons needs to be able to find a binary in /snap/bin too. On 10.x gdc compilers (part of the GNU Compiler Collection), the erorr message for an "unrecognized command line option" changed to "unrecognized command-line option". Wilcarded the changed character in the expectations of the one test which failed. Updated docs to indicate /opt/bin is part of env['PATH'] - it was not included, and added /snap/bin to accomodate this change. Signed-off-by: Mats Wichmann <mats@linux.com>
* | Merge pull request #3849 from mwichmann/compdb-notesWilliam Deegan2021-01-093-19/+106
|\ \ | | | | | | Adjust CompilationDatase documentation
| * | Adjust CompilationDatase documentation [skip appveyor]Mats Wichmann2020-12-233-19/+106
| |/ | | | | | | | | | | | | | | | | 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>
* | Update manpage section of Fortran suffixes [ci skip]Mats Wichmann2021-01-061-6/+30
|/ | | | | | | | | | The section mentioned only the .F suffix, added mention of the other variants and a brief note on what the difference means. Added some markup in the individual Fortran tools Doc-only change. Signed-off-by: Mats Wichmann <mats@linux.com>
* Fix botched checkin [skip appveyor]Mats Wichmann2020-11-271-47/+38
| | | | | | | Checked in the SCons/__init__.py instead of the changes to the sconsign manpage. Restoring the former and updating the latter. Signed-off-by: Mats Wichmann <mats@linux.com>
* Change variable from COMPILATIONDB_USE_PATH_FILTER to COMPILATIONDB_PATH_FILTERWilliam Deegan2020-11-241-6/+8
|\
| * Add COMPILATIONDB_USE_PATH_FILTER for filtering compilation database.James Benton2020-11-231-5/+53
| | | | | | | | The filter is a fnmatch pattern matched against output file.
* | Add COMPILATIONDB_USE_PATH_FILTER for filtering compilation database.James Benton2020-10-271-5/+52
|/ | | | | | The filter is a fnmatch pattern matched against output file. Also rename target->output in docs to match the output of compilation_db.
* [PR #3811] revert some Command syntax changes [ci skip]Mats Wichmann2020-10-101-16/+12
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* Update manpage on variable substitution [skip appveyor]Mats Wichmann2020-10-081-61/+93
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* Merge pull request #3804 from mwichmann/variant-docWilliam Deegan2020-10-044-158/+98
|\ | | | | Tweaks to variantdir documentation
| * Move a couple of User Guide chapters [skip appveyor]Mats Wichmann2020-10-021-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | Move the Repositories chapter to just after the Variantdirs chapter, since they're the same general topic - controlling source and destination locations in bulk. Also moved the internationalization chapter near the end, since it didn't seem to fit in the logical flow where it was. No doc contents changed - just order. Signed-off-by: Mats Wichmann <mats@linux.com>
| * [PR #3804] a couple of wording tweaks from PR review [ci skip]Mats Wichmann2020-10-011-1/+1
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * Tweaks to variant dir documentation [skip appveyor]Mats Wichmann2020-09-224-156/+96
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | Remove references to needing pywin32 from docs and readmesWilliam Deegan2020-10-041-3/+1
|/
* Merge pull request #3791 from mwichmann/sideeffectWilliam Deegan2020-09-197-108/+158
|\ | | | | Include SideEffect section into the UserGuide
| * [PR #3791] more doc reword per review comments [ci skip]Mats Wichmann2020-09-101-2/+3
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * [PR #3791] doc reword per review comment [ci skip]Mats Wichmann2020-09-101-6/+7
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * [PR #3791] fix typo detected by sider [skip appveyor]Mats Wichmann2020-09-041-1/+1
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * Include SideEffect section into the UserGuide [skip appveyor]Mats Wichmann2020-09-047-107/+155
| | | | | | | | | | | | | | Existing written doc, but was not included - now added to the Miscellaneous chapter. Some rewriting. Signed-off-by: Mats Wichmann <mats@linux.com>
* | [PR #3795] small wording update per PR review [ci skip]Mats Wichmann2020-09-181-1/+1
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* | [PR #3795] typo fix from sider [ci skip]Mats Wichmann2020-09-181-1/+1
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* | More clarification and fixes on Variables [skip appveyor]Mats Wichmann2020-09-179-77/+147
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | Matching Header fontGIT2020-09-101-1/+1
| |
* | Update simple.xmlGIT2020-09-071-1/+1
|/ | | I guess, double that is typo
* Merge pull request #3788 from mwichmann/actionstrWilliam Deegan2020-08-294-28/+100
|\ | | | | Updated docs on Actions for output control
| * and fix a "thinko" in new userguide example [skip appveyor]Mats Wichmann2020-08-282-2/+2
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * typo fix [skip appveyor]Mats Wichmann2020-08-281-2/+2
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * Updated docs on Actions for output controlMats Wichmann2020-08-284-28/+100
| | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | User Guide: don't link to tigris any more [ci skip]Mats Wichmann2020-08-291-2/+2
|/ | | | | | | | Troubleshooting section had a remaining link to tigris.org. Now points to scons website - not to github, because we don't encourage directly filing a bug before first discussing. Signed-off-by: Mats Wichmann <mats@linux.com>
* Merge pull request #3778 from mwichmann/man-toolsWilliam Deegan2020-08-241-33/+62
|\ | | | | man: expand explanations on selecting Tool modules
| * Further tweak to tool location doc (toolpath vs. site_tools vs builtin) [ci ↵Mats Wichmann2020-08-181-4/+7
| | | | | | | | | | | | skip] Signed-off-by: Mats Wichmann <mats@linux.com>
| * man: expand explanations on selecting Tool modules [ci skip]Mats Wichmann2020-08-161-32/+58
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* | Update docs on documentation [ci skip]Mats Wichmann2020-08-171-17/+69
|/ | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* [PR #3772] add definition of selected targets [skip appveyor]Mats Wichmann2020-08-121-20/+59
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
generated by cgit v0.12 at 2024-12-02 22:30:24 (GMT)