summaryrefslogtreecommitdiffstats
path: root/doc/user
Commit message (Collapse)AuthorAgeFilesLines
...
* 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>
* [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>
* Adjust CompilationDatase documentation [skip appveyor]Mats Wichmann2020-12-231-19/+98
| | | | | | | | | 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>
* 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.
* 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-223-156/+94
| | | | | | | | | | | | | | | | | | | 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-195-107/+153
|\ | | | | 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-045-106/+150
| | | | | | | | | | | | | | 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] 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-171-69/+126
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-292-6/+62
|\ | | | | Updated docs on Actions for output control
| * and fix a "thinko" in new userguide example [skip appveyor]Mats Wichmann2020-08-281-1/+1
| | | | | | | | 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-282-6/+62
| | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* Tweak Installing Python section in User Guide [skip appveyor]Mats Wichmann2020-08-111-23/+26
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* Tweak new dictionary sidebar in userguide [ci skip]Mats Wichmann2020-08-091-13/+15
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* Merge pull request #3751 from dirkbaechle/fix-dbhtml-metaencWilliam Deegan2020-08-021-1/+87
|\ | | | | [WIP] Enforcing HTML output encoding to UTF-8.
| * Enforcing HTML output encoding to UTF-8.Dirk Baechle2020-07-191-1/+87
| | | | | | | | | | | | | | | | The stylesheet for the single HTML outputs (not chunked) get adapted, such that UTF-8 is always used as output encoding for all chunks. In addition, the HTML header now contains a corresponding "content" tag, displaying the used charset=UTF-8. [skip ci]
* | [PR #3572] a bit more docbook markup in environments.xml [skip appveyor]Mats Wichmann2020-08-021-17/+14
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* | [PR #3752] doc tweaks to address review comments [ci skip]Mats Wichmann2020-08-021-2/+2
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* | [PR #375] minor doc tweak: dicts [skip appveyor]Mats Wichmann2020-07-261-11/+15
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* | [PR #3752] fix review comment on keywords [skip appveyor]Mats Wichmann2020-07-241-5/+3
| | | | | | | | | | | | | | | | | | Simplified the guide wording on source/target kwargs to get rid of an ambifuity. Some tweaking of the manpage on overrides and parse_args. Signed-off-by: Mats Wichmann <mats@linux.com>
* | [PR #3572] typo fix [skip appveyor]Mats Wichmann2020-07-231-1/+1
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* | [PR #3752] guide: update consvar setting after review [skip appveyor]Mats Wichmann2020-07-232-114/+253
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | Update docs on argument passing to Environment, etc.Mats Wichmann2020-07-227-123/+229
|/ | | | | | | | Adds a new uguide Ch 7 section on using the parse_flags method (with Ex.) Moves the section on overrides in calls to Builders to Chap 7 - it was using concepts not introduced yet where it was placed. Signed-off-by: Mats Wichmann <mats@linux.com>
* update some doc copyright dates/formattingWilliam Deegan2020-07-041-1/+1
|
* Tweak userguide wording on cachedir [ci skip]Mats Wichmann2020-06-301-20/+38
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* Add a new chapter on external tools to User Guide [ci skip]Mats Wichmann2020-06-245-82/+184
| | | | | | Initial content is the compilation_db material Signed-off-by: Mats Wichmann <mats@linux.com>
* Updated generated doc files and user manual.Dirk Baechle2020-06-201-2/+2
|
* Fix docbook 4.5 vs 5 usage [ci skip]Mats Wichmann2020-06-172-3/+2
| | | | | | | | | | | | | | | | Recent changes introduced the use of the Docbook 5 syntax for external links (<link xlink:href="https://www.example.com"/>), which works okay for the doc build, but breaks the internal tools which do formal validation against the scons-modified docbook DTD ("sconsdoc") because sconsdoc is a modification of Docbook 4.5 thus pinning us to that version. xlink was a Docbook 5 introduction to use more standard W3C syntax for the links (xlink is a W3C spec of its own). Back off this new usage: go back to the old usage pattern (<ulink url="https://www.example.com">), because trying to uplift sconsdoc looks a fairly substantial task. Signed-off-by: Mats Wichmann <mats@linux.com>
* Documentation updates in perparation for 4.0 [ci skip]Mats Wichmann2020-06-102-5/+6
| | | | | | | | | | | | | * 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>
* Merge pull request #3662 from bdbaddog/add_compilation_dbWilliam Deegan2020-06-083-0/+68
|\ | | | | Add compilation db for use by clang tools and cquery (fix issue #3355)
| * [ci skip] updates based on mwichmann's review of the PRWilliam Deegan2020-06-071-3/+2
| |
| * change CompilationDatabase from psuedo builder to builder. Add emitter to ↵William Deegan2020-06-061-0/+15
| | | | | | | | clear source and set default target as 'compile_commands.json'.
| * [ci skip] a little formatting changeWilliam Deegan2020-05-291-24/+33
| |
| * [ci skip] Add initial section for Users Guide misc section for compilation ↵William Deegan2020-05-271-0/+42
| | | | | | | | database
| * add commented out XSLTFLAGS info which may enable creating PDF bookmarksWilliam Deegan2020-05-271-0/+1
| |
| * add comment to indicate which sections are appendixWilliam Deegan2020-05-271-0/+2
| |
* | Fix userguide entity typo [ci skip]Mats Wichmann2020-06-041-1/+1
| | | | | | | | | | | | &f-GetOption; was not properly camelcased in recent commit. Signed-off-by: Mats Wichmann <mats@linux.com>
* | [ci skip] fix typo in markupWilliam Deegan2020-06-041-1/+1
| |
* | [PR #3682] drop one more env var $ introducer [ci skip]Mats Wichmann2020-06-031-1/+1
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
generated by cgit v0.12 at 2025-09-11 09:33:28 (GMT)