summaryrefslogtreecommitdiffstats
path: root/doc/man
Commit message (Collapse)AuthorAgeFilesLines
* Remove deprecated env.Copy()Mats Wichmann2019-12-141-16/+2
| | | | | | | | | Method removed. Test moved to test/Removed/Copy-Method/Old, and new test added to ensure it takes an AttributeError. Deprecation warning no longer useful for this one, so removed. Signed-off-by: Mats Wichmann <mats@linux.com>
* Merge branch 'master' into py3-doctasksWilliam Deegan2019-12-101-39/+18
|\
| * Update debug=action-timestampsMats Wichmann2019-12-071-41/+20
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | + Rename to action-timestamps (from action_timestamps) for consistency with other compound word options. + Put manpage entry in alphabetical order. + Describe what option does and shorten it (refers to debug=time instead of duplicating it) + Change prints a bit (and tests to match) + Show scons version where added. + Slight adjustment to manpage introduction to debug options. Along the way, fixes a lingering tag mismatch from an earlier documentation PR. Updates PR#3456 Signed-off-by: Mats Wichmann <mats@linux.com>
* | [PR #3343] fix review comments [ci skip]Mats Wichmann2019-12-051-2/+2
| | | | | | | | | | | | | | | | | | | | 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-051-2/+2
|/ | | | | | | | | | | | | | | | | | | | * 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 Builder keywordsMats Wichmann2019-10-221-1/+2
| | | | | | overrides= and scanner= have been deprecated for over a decade. Signed-off-by: Mats Wichmann <mats@linux.com>
* Remove deprecated {Source,Target}SignaturesMats Wichmann2019-10-201-21/+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>
* Merge pull request #3462 from mwichmann/msvc_env_cacheWilliam Deegan2019-10-121-12/+53
|\ | | | | enable experimental persistent caching of vcvars on win32
| * [PR 3462] update doc/comments for msvc-env-cacheMats Wichmann2019-10-121-14/+20
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * [PR 3462] python two handle the jsonMats Wichmann2019-10-111-6/+17
| | | | | | | | | | | | | | | | | | reading the cache from the json file got us unicode when running python2, and this broke certain tests when calling subprocess.Popen: TypeError, because all the environment wasn't strings, some was unicode. Signed-off-by: Mats Wichmann <mats@linux.com>
| * [PR 3462] env-var-cache: fix exception to be 2.7 compatibleMats Wichmann2019-10-101-13/+37
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | msvc env-var cache-read function use 'except IOError' since 'FileNotFoundError' did not exist on Py2.7/win32. try to handle error if caceh write fails. add SCONS_CACHE_MSVC_CONFIG to manpage. SCONS_CACHE_MSVC_CONFIG can take a pathname to specify the cache file to use, or it can use the default. slightly simplified logging setup - logging is stdlib since py2.3, no need for try block on import. Signed-off-by: Mats Wichmann <mats@linux.com>
* | Merge remote-tracking branch 'origin/master'Edoardo Bezzeccheri2019-10-091-1/+1
|\ \ | |/ | | | | | | # Conflicts: # src/CHANGES.txt
| * fix typo: missing quote in a manpage example [ci skip]Mats Wichmann2019-10-051-1/+1
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* | Added debug option "timestamp", changed option "timestamp" to ↵Edoardo Bezzeccheri2019-10-091-1/+1
| | | | | | | | | | | | "action_timestamps" As per PR review
* | Added debug option "timestamp", documentationEdoardo Bezzeccheri2019-10-011-1/+35
|/
* Docs for InstallVersionedLib and --install-sandbox [ci skip]Mats Wichmann2019-09-251-0/+12
| | | | | | | | | | | 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 #3444] fix test issues with --debug removalsMats Wichmann2019-09-121-40/+0
| | | | | | | | | | There were several uses of deprecated debug flags that had not been moved to to test/Deprecated, and so were missed when those moved to test/Removed. Also removed options from manpage. Signed-off-by: Mats Wichmann <mats@linux.com>
* [PR #3437] review comment - add back curly bracesMats Wichmann2019-09-101-4/+7
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* Builder and Variable Subst doc updates [ci skip]Mats Wichmann2019-09-091-151/+211
| | | | | | | | | | | | | | | | | | | | Work on Builder Methods and Variable Substitution man sections - some wording tweaks, do some formatting markup a little more consistently, etc. Tweak the wording for the Command builder, a description shared between manpage and userguide. Closes #3030: Environment.xml had many references to detail sections elsewhere, like "see XXX section below," which don't work well - this xml is generated into both the manpage and the user guide, and the locality of saying "below" is incorrect for the latter since those sections are only in the manpage. Essentially these are changed to say "see the manpage section XXX". Adding clickable links is of course also possible, but I recall there was some objection to cross-document links, so I didn't do that. Signed-off-by: Mats Wichmann <mats@linux.com>
* Merge pull request #3425 from mwichmann/tool-docsWilliam Deegan2019-09-071-30/+51
|\ | | | | manpage: clarify that tools=[list] overrides [ci skip]
| * manpage: clarify that tools=[list] overrides [ci skip]Mats Wichmann2019-09-071-30/+51
| | | | | | | | | | | | | | | | | | Also some formatting tweaks, and a couple of typos. The description of the default tool now lists some of what that may include. Signed-off-by: Mats Wichmann <mats@linux.com>
* | purge aegis referencesWilliam Deegan2019-09-071-53/+0
|/
* Update Dictionary documentation to match implementation [ci skip]Mats Wichmann2019-08-251-26/+33
| | | | | | | | | | | | | | | | | | 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>
* Update docs for parse_flags keywordsMats Wichmann2019-05-141-4/+8
| | | | | | | | | 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>
* Give sconsign a default filename.Mats Wichmann2019-04-051-20/+36
| | | | | | | | | | | | | | | | sconsign required filename(s) or directory name(s) to do anything, in their absence it just quits silently. Change so if filename argument omitted, use the same default as scons - .sconsign.dblite. print something in case of bad options. add an extra info line in case the sconsign cannot be read due to pickle protocol (when py2 used in a place where scons previously run with py3) Tweak the manpage a bit. Signed-off-by: Mats Wichmann <mats@linux.com>
* Minor manpage bugfixMats Wichmann2019-02-211-2/+2
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* Merge pull request #3261 from mwichmann/doc-defaultWilliam Deegan2019-02-021-1/+1
|\ | | | | Improve scons docs regarding Default()
| * Work on Default docu wording a bit moreMats Wichmann2019-01-191-1/+1
| | | | | | | | | | | | | | 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-2/+2
|/
* Update some doc examplesMats Wichmann2019-01-041-7/+7
| | | | | | | | 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-1/+1
|\ | | | | Update docs about installing scons3 (issue #3037)
| * A few more wording tweaks on scons/python installMats Wichmann2018-12-021-1/+1
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * Update docs about installing scons3Mats Wichmann2018-12-021-1/+1
| | | | | | | | | | | | | | | | 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>
* | Merge remote-tracking branch 'upstream/master' into ↵William Deegan2018-12-051-7/+11
|\ \ | |/ | | | | fix_mac_shlibversion_gh_issue_3241
| * PR #3238: sconsign manpage wording for unknown format.Mats Wichmann2018-12-011-3/+3
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * Some fixes to sconsignMats Wichmann2018-12-011-6/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Two locations which attempt to directly print an item tipped over on py3, so they now decode(). There seem to be cases where implicit dependencies do not have signatures, so instead of looping through the dep list and indexing into the signature list (IndexError), the two lists are now zipped, which means nothing is printed, but sconsign does not die (the zip technique is used in FS.py in the engine). Minor PEP8 changes: spaces around operators; shorter lines; two-blanks rule around classes/functions. Also unused args changed to _ to show it was intentional. Manpage updated slightly - the internal whichdb function explicitly looks for the .dblite suffix, so the claim that if it's not .dbm it is assumed to be dblite was not true. sconsign still will not work on a dblite file which is not suffixed .dblite, but that is an existing problem, not a newly introduced one. Signed-off-by: Mats Wichmann <mats@linux.com>
* | Doc updates. Some issues with generated files, but use for nowWilliam Deegan2018-12-051-2/+2
|/
* initial support for virtualenvPaweł Tomulik2018-11-101-0/+12
|
* Added in support for Sconstruct.pygrbd2018-04-151-0/+4
|
* Added sconstruct.py lowercasegrbd2018-04-021-8/+12
|
* updates to docs for SConstruct.pygrbd2018-04-021-5/+9
|
* Fix nested list formatting in manpageMats Wichmann2017-12-211-11/+24
| | | | | | | | | The definition of the list term "--debug=list" contains a list of its own; the list tiems in this list need to have their text contents wrapped in paragraph tags. Signed-off-by: Mats Wichmann <mats@linux.com>
* Remove unused warnings from the man page and Warnings.pyAndrew Featherstone2017-12-031-11/+0
| | | | This warning was never used in the code.
* Remove testing for hashlib and corresponding support for command line options.Andrew Featherstone2017-12-021-9/+0
| | | | hashlib is part of the standard library since Python 2.5, and SCons supports Python 2.7 and later.
* Doc updatesWilliam Deegan2017-11-141-1/+1
|
* Add printing time processing each SConscript when --debug=time is specified ↵William Deegan2017-10-201-9/+14
| | | | on command line
* Fix logic which was broken by automatic fixers. the sort parameter to ↵William Deegan2017-10-111-1/+3
| | | | GenerateHelpText() is now actually called.
* Updated the documentation for nested tools located within subdirsgrbd2017-06-191-0/+16
|
* Remove ancient Aegis revision control system filesJane Doe2017-05-301-4/+0
|
* Use print() function to fix py2/3Craig Rodrigues2017-03-101-18/+18
|