summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* manpage tweaks [skip appveyor]Mats Wichmann2020-08-121-38/+42
| | | | | | | | | | | | | | | In DESCRIPTION, turn function references into clickable links. Also turn special variables into link references, which necessitated defining identifiers for them, as these are not part of the generated entities process. Introduce the term "execution environment" in the intro section for terminology consistency, since this term is defined in the User Guide (Chapter 7, Environments). Change wording of the -c option slightly. 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>
* Merge pull request #3762 from mwichmann/man-noteWilliam Deegan2020-08-091-0/+6
|\ | | | | Trivial: add a comment about options to manpage source
| * tweak varlist options commend in manpage src [ci skip]Mats Wichmann2020-08-021-3/+4
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * Minor: add a comment about options to manpage source [ci skip]Mats Wichmann2020-08-021-0/+5
| | | | | | | | | | | | | | | | | | Explain why we don't use this form of listing options in manpage: <varlistentry><term>-A</term><term>--a-long-opt</term>... i.e. a term for each variant of an option. This is a comment only, no change to actual manpage. 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-024-12/+373
|\ \ | | | | | | [WIP] Enforcing HTML output encoding to UTF-8.
| * | Enforcing HTML output encoding to UTF-8.Dirk Baechle2020-07-194-12/+373
| |/ | | | | | | | | | | | | | | 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]
* | Merge pull request #3752 from mwichmann/doc-overridesWilliam Deegan2020-08-0213-277/+547
|\ \ | | | | | | Update docs on argument passing to Environment, etc.
| * | [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>
| * | Fix xml validation errorMats Wichmann2020-07-241-1/+1
| | | | | | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * | [PR #3752] fix review comment on keywords [skip appveyor]Mats Wichmann2020-07-242-45/+52
| | | | | | | | | | | | | | | | | | | | | | | | | | | 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-234-114/+262
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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-2210-124/+238
| |/ | | | | | | | | | | | | | | 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>
* | [PR #3756] review: do not use CAPS for manpage option [skip appveyor]Mats Wichmann2020-07-261-5/+8
| | | | | | | | | | | | | | | | | | | | Two manpage options from a previous commit had the option-argument listed in caps to match the --help output. A review comment suggested not to do this, as all-caps indicates a construction variable. Question: should the AddOption calls for these two set a metavar to match the current documentation? Signed-off-by: Mats Wichmann <mats@linux.com>
* | Rename some doc files; Packaging doc fixups [skip appveyor]Mats Wichmann2020-07-251-4/+18
|/ | | | | | | | | | | | | | | | | | | | | Renamed those documentation files named __init__.xml to the name of the component directory. Merged SCons/Tool/packaging.xml (which had no unique content) into the renamed SCons/Tool/packaging/packaging.xml Considerable rework was needed to the packaging content to fill in some gaps: * properly named the commandline option * add the option to the manpage (with a note it's not always avail) * only list the packagers once * add example of selecting packaging tool, and of specifying multiple packagers * more description of source, target and metadata for Packaging * mention use of PACKAGEROOT * redo tag description * add a bit of explanation to the complete packaging example Signed-off-by: Mats Wichmann <mats@linux.com>
generated by cgit v0.12 at 2024-12-03 15:21:20 (GMT)