summaryrefslogtreecommitdiffstats
path: root/doc/user
Commit message (Collapse)AuthorAgeFilesLines
* Remove deprecated BuildDir, build_dirMats Wichmann2019-12-151-4/+2
| | | | | | | | | Updates docs and code; moves tests to test/Removed/BuildDir/Old. New tests verify that these can no longer be used. Along the way a small cleanup in SConscript.py Signed-off-by: Mats Wichmann <mats@linux.com>
* Tweak DefaultEnvironment descriptions (ci skip)Mats Wichmann2019-12-131-31/+27
| | | | | | | | | | | Doc-only change to be more explicit about when the default construction environment is used, and what it means to call DefaultEnvironment() - only the first call instantiates it, later calls return the object. Fixes #2477 Signed-off-by: Mats Wichmann <mats@linux.com>
* Merge branch 'master' into py3-doctasksWilliam Deegan2019-12-101-8/+55
|\
| * [PR 3475] further wording tweaks on AddOption [ci skip]Mats Wichmann2019-11-211-12/+18
| | | | | | | | | | | | | | | | | | | | Reword some parts. Add note to manpage that AddOption does not support matching "abbreviations" for long option names. Add note to manpage and user guide that you can't SetOption on options added via AddOption. (as noted in issue #2105) Signed-off-by: Mats Wichmann <mats@linux.com>
| * [PR 3475] review edit: space -> whitespace [ci skip]Mats Wichmann2019-11-151-2/+2
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * [PR 3475] add repeated-args suggestion for AddOpt [ci skip]Mats Wichmann2019-11-151-19/+26
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * Document that AddOpt has limitations [ci skip]Mats Wichmann2019-11-132-0/+35
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Manpage describes that using spaces between AddOption'd option and its argument is undefined. Use Guide goes into more detail, including workarounds. :: these are not a solution, but do at least reduce the surprise factor. (multiple github issues) Fix tag mismatch in depends.xml introduced by a previous deletion. Signed-off-by: Mats Wichmann <mats@linux.com>
* | [PR #3343] fix review comments [ci skip]Mats Wichmann2019-12-051-0/+1
| | | | | | | | | | | | | | | | | | | | get importlib magic number from util sider complaints about unicode usage sider complaint about subprocess return value unused sider complaint about shutil import unused (it is used, but inside a big string that is written to a file to be executed) Signed-off-by: Mats Wichmann <mats@linux.com>
* | Improve building of docs using Py3 [ci skip]Mats Wichmann2019-12-0510-27/+31
|/ | | | | | | | | | | | | | | | | | | | * context managers on file r/w + use shutil.copy where it makes sense. * lxml wants (demands?) that xml files be processed as bytes * for the phase where we gen the entity files, read as text anyway * Need to solve a problem where the generated xml is putting the \n in literally, not evaluating it. * Fix some examples broken for py3 * Fix more octal constant instances * Cleanups suggested by PyCharm: staticmethods, two blanks before class definition, others. This addresses issues called out in #3300, but is not a complete solution because the actual doc build step still fails with the epydoc failures (which aren't directly because of Py3; epydoc build doesn't work any better on my system with Py3, even with the forked version with patches). Signed-off-by: Mats Wichmann <mats@linux.com>
* Remove deprecated {Source,Target}SignaturesMats Wichmann2019-10-201-178/+0
| | | | | | | | | | These two have been deprecated since 2010 (about SCons 2.0), commit 935e6985. Methods are removed, setoption for setting them removed, doc is removed, tests are migrated to test/Removed/*/Old with a sconstest.skip file so they don't run, and two new tests are added to confirm that using the functions and setoptions generate exceptions. Signed-off-by: Mats Wichmann <mats@linux.com>
* Fix a syntax error in the documentationTheogen Ratkin2019-10-021-1/+1
| | | Quotation marks do not match, which is a syntax error.
* Docs for InstallVersionedLib and --install-sandbox [ci skip]Mats Wichmann2019-09-251-4/+66
| | | | | | | | | | | Adds --install-sandbox to manpage options and to section on Install builder. Adds mention of InstallVersionedLib to user guide. Fixes #3007 Signed-off-by: Mats Wichmann <mats@linux.com>
* [PR #3423] further wording tweak for Dictionary [ci skip]Mats Wichmann2019-08-251-10/+10
| | | | | | | And replaces some written out "construction environment" and "construction variable" uses with existin entities. Signed-off-by: Mats Wichmann <mats@linux.com>
* Update Dictionary documentation to match implementation [ci skip]Mats Wichmann2019-08-251-4/+15
| | | | | | | | | | | | | | | | | | Dictionary is now described as returning a dict only if called with no arguments; if called with arguments it returns a string or list of strings (matching the implmenentation). Note env.Dump() only takes zero arguments or one, it it not documented as taking the multiple keys, so there's less ambiguity with it. Some examples twiddled a little, and in a couple of cases Dictionary is not used any longer - we might as well just index into the construction environment since that works. Fixes #3156 Signed-off-by: Mats Wichmann <mats@linux.com>
* [ci skip] Clarify docs about writing your own Builder and link to Action ↵Mathew Robinson2019-08-061-10/+11
| | | | Objects man page
* More decider doc updates regarding adding new repo_node argumentWilliam Deegan2019-07-141-1/+8
|
* Doc updates for repo_node addition to Decider function argsWilliam Deegan2019-07-141-1/+1
|
* Update docs for parse_flags keywordsMats Wichmann2019-05-141-8/+10
| | | | | | | | | The somewhat poorly named parse_flags keyword args actually work like the MergeFlags method - don't just split like the ParseFlags method, but do the merging as well. Tweak the docs and add a reference to env.MergeFlags. Signed-off-by: Mats Wichmann <mats@linux.com>
* Merge pull request #3261 from mwichmann/doc-defaultWilliam Deegan2019-02-021-8/+10
|\ | | | | Improve scons docs regarding Default()
| * Work on Default docu wording a bit moreMats Wichmann2019-01-191-8/+10
| | | | | | | | | | | | | | An earlier change updated some examples, this makes some tweaks to the wording as well for Default, DEFAULT_TARGETS, etc. to clarify. Signed-off-by: Mats Wichmann <mats@linux.com>
* | Changes for 3.0.4 release3.0.4William Deegan2019-01-231-1/+1
|/
* updates from update-release-info for 3.0.3 releaseWilliam Deegan2019-01-061-2/+2
|
* Update some doc examplesMats Wichmann2019-01-041-7/+6
| | | | | | | | map() now returns an interable instead of a list, update examples which assumed they could just print() the result of a map(). Signed-off-by: Mats Wichmann <mats@linux.com>
* Merge pull request #3249 from mwichmann/doc-install-updateWilliam Deegan2018-12-171-241/+49
|\ | | | | Update docs about installing scons3 (issue #3037)
| * More requested changes to install doc (PR #3249)Mats Wichmann2018-12-171-17/+7
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * PR #3249 typo fixMats Wichmann2018-12-031-1/+1
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * A few more wording tweaks on scons/python installMats Wichmann2018-12-021-13/+18
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * Update docs about installing scons3Mats Wichmann2018-12-021-238/+51
| | | | | | | | | | | | | | | | Installing via pip now preferred; no more native-type packages (rpm, msi). Python 3 is supported - seemed one more place was missed that said it had to be Py2. Signed-off-by: Mats Wichmann <mats@linux.com>
* | fix broken xml in docsWilliam Deegan2018-12-062-26/+35
| |
* | Doc updates. Some issues with generated files, but use for nowWilliam Deegan2018-12-052-14/+4
|/
* corrections after bdbaddog's code reviewPaweł Tomulik2018-11-101-1/+1
|
* initial support for virtualenvPaweł Tomulik2018-11-101-0/+49
|
* Fix some misspellings, remove repeated: andPiotr Kasprzyk2018-07-202-4/+4
| | | | Signed-off-by: Piotr Kasprzyk <ciri@ciri.pl>
* Fix typos from issue 3194Mats Wichmann2018-07-171-3/+3
| | | | | | https://github.com/SCons/scons/issues/3149 Signed-off-by: Mats Wichmann <mats@linux.com>
* typo Hao Wu2018-07-111-1/+1
| | | credit: https://stackoverflow.com/questions/39856184/does-scons-customized-decider-function-require-to-be-class-member
* Fix running my_command example script in exampleWilliam Deegan2018-02-191-1/+1
|
* Remove duplicate example. Likely caused by bad mergeWilliam Deegan2018-02-191-20/+0
| | | | Fixes #2983
* Fixed print statement to work with py2/3William Deegan2017-11-144-24/+24
|
* fix spelling for emitterWilliam Deegan2017-09-241-2/+2
|
* addition to user docsgrbd2017-09-242-3/+113
|
* Fix Bug #3020 - Download link in user guide broken. python setup.py install ↵William Deegan2017-08-191-1/+1
| | | | --version-lib broken. Now fixed
* Added fixes for docs / nested test for use of sys.path in toolpathgrbd2017-08-041-18/+31
|
* Added docs for use of the PyPackageDir functiongrbd2017-08-031-0/+32
|
* removed ENV = os.environ from the examplesgrbd2017-08-021-4/+4
|
* Update to user manual on how to use sys.path for toolpath, and toolpath in ↵grbd2017-08-012-47/+124
| | | | | | general also small update to tests
* Updated the documentation for nested tools located within subdirsgrbd2017-06-191-0/+47
|
* changes to prep for 3.0.0 alphaWilliam Deegan2017-06-141-2/+2
|
* Remove ancient Aegis revision control system filesJane Doe2017-05-301-4/+0
|
* Use print() function to fix py2/3Craig Rodrigues2017-03-107-52/+52
|
* Fix documentation example output to match actual output (Fix #2788)Gaurav Juvekar2017-01-281-5/+5
|
generated by cgit v0.12 at 2025-04-12 08:12:22 (GMT)