summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Merge pull request #4299 from mwichmann/doc/uguide-pseudoHEADmasterWilliam Deegan2023-05-174-81/+81
|\ | | | | Tweak pseudo-builder in user guide
| * Minor update to scanner descriptionWilliam Deegan2023-05-171-4/+7
| |
| * Put back Builder entityref in UG add-method [skip appveyor]Mats Wichmann2023-05-081-6/+11
| | | | | | | | | | | | | | | | | | | | Entity reference &Builder;s was turned to plain text in a few places. Restored, this time using existing pluralized entity name &Builders;. Also twiddled a little wording in same User Guide chapter. Signed-off-by: Mats Wichmann <mats@linux.com>
| * UGuide; tweak Scanner intro again [skip appveyor]Mats Wichmann2023-02-233-6/+13
| | | | | | | | | | | | | | Put back the previous wording, now with glossary entry that also defines the plural form Scanners (there is still no actual glossary) Signed-off-by: Mats Wichmann <mats@linux.com>
| * User Guide fixups [skip appveyor]Mats Wichmann2023-02-222-33/+33
| | | | | | | | | | | | | | | | | | | | | | For add-method chapter, plus the following scanners chapter, normalize usage a little: the first mention in any given section uses the marked-up form &Builder; and &Scanner;, which contain index references, subsequent ones do not. Only references to Scanner as a concept are capitalized, things like "scanner function" were left alone. Signed-off-by: Mats Wichmann <mats@linux.com>
| * Restore markup of Builder in PR 4299 [skip appveyor]Mats Wichmann2023-02-212-6/+6
| | | | | | | | | | | | | | | | The add-method chapter now has entity references to &Builder; back. The markup for &Builder; is changed from <classname> to <indexterm>, as used it's a concept, and there is no actual class named Builder anyway. Signed-off-by: Mats Wichmann <mats@linux.com>
| * Tweak pseudo-builder in user guide [skip appveyor]Mats Wichmann2023-02-111-44/+29
| | | | | | | | | | | | Minor fiddling - example format, headers, wordings tweaks Signed-off-by: Mats Wichmann <mats@linux.com>
* | Doc fiddling - Alias, Action, Decider [skip appveyor]Mats Wichmann2023-05-162-6/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | * Signature of Alias() now matches implementation to avoid problem if kwargs used * Case of Alias with no targets is mentioned in text (was already shown in example) * Now mention that Action([item]) does not return a ListAction - previously implied that if arg was a list, a ListAction was *always* returned * Mention default Decider and sort the names of available decider functions, and add version marking. * Minor fiddling with Alias.py docstrings. Signed-off-by: Mats Wichmann <mats@linux.com>
* | Updates post 4.5.2 releaseWilliam Deegan2023-03-211-1/+1
| |
* | Regenerated docs for 4.5.2 release.William Deegan2023-03-211-3/+3
| |
* | Post release changesWilliam Deegan2023-03-071-1/+1
| |
* | Regenerated docs for 4.5.1 releaseWilliam Deegan2023-03-061-3/+3
| |
* | Post release UpdatesWilliam Deegan2023-03-051-2/+2
| |
* | Regenerated docs for 4.5.0 release.William Deegan2023-03-0511-742/+1399
|/
* Add unique kwarg to CheckLibsMats Wichmann2023-01-271-14/+29
| | | | | | | | | | Minor tweak to CheckFunc - the dummy prototype should have a dummy arg list too (comment from Python setuptools discussion). Might as well fail the official way: #error instead of C syntax error. Fixes #2768 Signed-off-by: Mats Wichmann <mats@linux.com>
* Add "append" kwarg to two configure checksMats Wichmann2023-01-241-79/+100
| | | | | | | | | | | | | | Add append=True/False to CheckLib, CheckLibWithHeader in SConf. The "implementation", Conftest.CheckLib, already accepted this kwarg, but it could not be passed from an SConscript using the offical API. Updated manpage to describe and expanded a unit test to check. Fixes #2767 Additionally, clarified some things in manpage, including a recent user confusion about how to call CheckFunc. Signed-off-by: Mats Wichmann <mats@linux.com>
* uguide: clarify VariantDir example [skip appvyor]Mats Wichmann2022-12-161-16/+21
| | | | | | | | A little more tweaking to show all references have to be to the variant dir (the "implied target" form of the example might let readers miss it applies to targets too). Signed-off-by: Mats Wichmann <mats@linux.com>
* Clarify build tree separation wording [skip appveyor]Mats Wichmann2022-12-151-1/+1
| | | | | | | Review pointed out that a use of the term "build" wasn't that clear, "build tree" would be more descriptive. Signed-off-by: Mats Wichmann <mats@linux.com>
* uguide: variant dir tweaking [skip appveyor]Mats Wichmann2022-12-154-193/+249
| | | | | | | | | | | | | | | | | | | | | | | Try to clarify some more about variant dirs (people are still getting confused), without getting too technical about it, in the spirit of the User Guide. Also some stuff about hierarchical builds - both manpage and user guide. User guide chunks that were modified anyway had section IDs added. This is part of a plan to gradually get rid of horrible-looking autogenerated links which are not constant (problem when Google archives something and then maybe it doesn't work). May look like this in a browser: https://scons.org/doc/production/HTML/scons-user.html#idp105548893220944 With assigned IDs, looks more like: .../HTML/scons-user.html#sect-variant-sconscript So far only three userguide files changed. Signed-off-by: Mats Wichmann <mats@linux.com>
* Tweak no-exec manpage wording [skip appveyor]Mats Wichmann2022-12-081-16/+21
| | | | | | | Minor change - this was one of the options where the xml id was changed, and the previous wording just didn't seem to be that smooth. Signed-off-by: Mats Wichmann <mats@linux.com>
* Manpage tweaking [skip appveyor]Mats Wichmann2022-12-061-138/+142
| | | | | | | | | | | | | * Reworded the section on --experimental - separate when the two current features were made available, and when --experimental itself was added. * Reworded in GetOption * Changed tags on a few options * Use entity forms in more places (Python -> &Python;, SConscript -> &SConscript; etc.) * Make changed/added notifications more consistent with what Sphinx produces for the API docs (:versionadded: and :versionchanged: markup) Signed-off-by: Mats Wichmann <mats@linux.com>
* [ci skip] Fix formatting for which versions introduced which experimental ↵William Deegan2022-12-041-2/+2
| | | | features
* Added --experimental=tm_v2 which switches to use Andrew Morrow's new ↵William Deegan2022-12-041-2/+3
| | | | ParallelJob implementation. WHich should scale much better for highly parallel builds
* Update setup/installation chapter in User Guide [skip appveyor]Mats Wichmann2022-11-121-255/+173
| | | | | | | | | | | No longer tell people to install via "python setup.py install", possibly with arguments on library directories and paths. Simplify, and mention use of virtualenvs as the current way to have multiple SCons versions installed. Fixes #4259 Signed-off-by: Mats Wichmann <mats@linux.com>
* Small cleanup in BoolVariable [skip appveyor]Mats Wichmann2022-10-222-6/+6
| | | | | | | | | For consistency, have BoolVariable usage use True and False instead of 0 and 1 - mainly this is tests and doc examples. Reformatted a few embedded test files. Signed-off-by: Mats Wichmann <mats@linux.com>
* Merge pull request #4244 from mwichmann/java-scanner-pathsWilliam Deegan2022-10-202-34/+23
|\ | | | | Java scanner don't split JAVACLASSPATH on space
| * Add Java scanner to generated API docsMats Wichmann2022-10-201-0/+8
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * Java scanner don't split JAVACLASSPATH on spaceMats Wichmann2022-10-171-34/+15
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The scanner now splits JAVACLASSPATH before searching only if it is passed as a scalar (string); it no longer recurses to split elements of a list value - this is more consistent with other SCons usage. No longer splits on space, rather splits on os.pathsep, as considerably more useful for a search-path variable. The latter change avoids breaking paths with an embedded space (usually from Windows). This is a "breaking change" from the new behavior introduced in 4.4 where a JAVACLASSPATH like "aaa bbb ccc" would have been split into ["aaa", "bbb", "ccc"] - now it will be left unchanged in the scanner. However a JAVACLASSPATH like "aaa;bbb;ccc" will now be split into ["aaa", "bbb", "ccc"]. This behavior only affects the scanner - there is no change in how JAVACLASSPATH gets transformed into the "-classpath ARG" argument when calling JDK elements. The former behavior was presumably unintended, and definitely broke on a space-containing path (e.g. "My Classes". The unit test is expanded to test for a path string with spaces, and for a path string containing a search-path separator. Documentation tweaks: explain better how JAVACLASSPATH (and the other two Java path variables) can be specified, and whether or not SCons changes them before calling the JDK commands. Added note that JAVABOOTCLASSPATH is no longer useful, and a note about the side effect that SCons always supplies a "-sourcepath" argument when calling javac. Fixes #4243 Signed-off-by: Mats Wichmann <mats@linux.com>
* | Adjust Sphinx doc build for moved Taskmaster [skip appveyor]Mats Wichmann2022-10-203-8/+23
|/ | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* Fix references to SCons.Jobs -> SCons.Taskmaster.Jobs which weren't caught ↵William Deegan2022-10-121-8/+0
| | | | by pycharm refactoring
* Modernize SCONS_CACHE_MSVC_CONFIG manpage entry [skip appveyor]Mats Wichmann2022-09-261-17/+17
| | | | | | | | Mention name change; remove the wording about version changes possibly causing problems - the currrent implementation should be resilient to this. Signed-off-by: Mats Wichmann <mats@linux.com>
* Update the Glob docs with more detailsMats Wichmann2022-09-163-10/+16
| | | | | | | | | Covers xml file for manpage, very minor stuff in uguide, and docstring in code. Also tweaked Ignore manpage entry, only because it was the very next description in Environment.xml and caught the eye. Signed-off-by: Mats Wichmann <mats@linux.com>
* Handle a list as source in CopyMats Wichmann2022-09-122-9/+17
| | | | | | | | | | | | | | | | | | | | | | | | | | | Copy (in the copy_func()) unconditionally converts the source argument to a string. This breaks the case where it was passed as a list - it should remain a list with the members converted to string, rather than being a single string. We assume a list source is supported, since the code just a few lines lower down detects a list and iterates through it. A test is added in test/Copy-Action.py to try to detect this case - it fails before the change and passes after. With the change to make a list argument work, found that the message printed by the matching strfunction (originally a lambda) needed the same adjustment, if the caller did not supply a list that was already strings (e.g. a list of Nodes, as from calling Glob()). Fixed up. At the same time, did some fiddling with the other Action Functions. Chmod had not been adjusted to emit the new Python standard for octal values (0o755 instead of 0755) - the change is only for the message, not for the function, but required aligning the test with the new format. Added some docstrings. Fixes #3009 Signed-off-by: Mats Wichmann <mats@linux.com>
* Merge pull request #4219 from mwichmann/doc/sphinx-tweaksWilliam Deegan2022-09-113-18/+42
|\ | | | | Doc/sphinx tweaks
| * Needed to turn off sphinx-rtd-theme another place [skip appveyor]Mats Wichmann2022-08-211-1/+1
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * sider: fix typo in comment in sphinx config [skip appveyor]Mats Wichmann2022-08-181-1/+1
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * Tweak the apidocs buildMats Wichmann2022-08-183-17/+41
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Be more explicit about napoleon config, and tweak to allow "Attribute" to be grouped as for "Arguments" (:attr: and :param: in the numpy style). * Disable inherited members for the Errors module, because the exception classes were picking up bits from the Python base Exception, which has no annotation available. * Update the introduction. Experimentally, try the "sphinx-book" theme (we can go back to sphinx-rtd-theme before pushing if this is disliked). Signed-off-by: Mats Wichmann <mats@linux.com>
* | Merge pull request #4220 from mwichmann/maint/no-dos-endingsWilliam Deegan2022-09-116-562/+562
|\ \ | | | | | | Convert line endings on sources
| * | Convert line endings on sources [skip appveyor]Mats Wichmann2022-08-206-562/+562
| |/ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Some file still were checked in with DOS-style line endings. Convert for consistency, and let git handle line endings on checkout for the platform in question. Did *not* convert svg files. Added .git-blame-ignore-revs with this revision listed to be able to ignore this change when doing "git blame --ignore-revs-file=...". To not have to manually type the option, can do: git config --global blame.ignoreRevsFile .git-blame-ignore-revs Signed-off-by: Mats Wichmann <mats@linux.com>
* | manpage - fix grammar problem [skip appveyor]Mats Wichmann2022-08-231-1/+1
| | | | | | | | | | | | A stray word wasn't immediately spotted as it appeared on the next line. Signed-off-by: Mats Wichmann <mats@linux.com>
* | manpage hash-format - use present tense [skip appveyor]Mats Wichmann2022-08-231-7/+7
| | | | | | | | | | | | | | Since we're here anyway, use present tense (rather than future) for the --hash-format section. Signed-off-by: Mats Wichmann <mats@linux.com>
* | Check in forgotten entity definition [skip appveyor]Mats Wichmann2022-08-231-0/+1
| | | | | | | | | | | | | | Added a plural of build signature to scons.mod and forgot to check in the change to that file, so validation failed on the CI run. Signed-off-by: Mats Wichmann <mats@linux.com>
* | Tweak --hash-format manpage entry [skip appveyor]Mats Wichmann2022-08-231-14/+21
|/ | | | | | | | | Previously, there are some wording problems and one paragraph was essentially a restatement of an earlier one. Also corrected the claim that --hash-format=md5 would create an unadorned .sconsign.dblite - tested to show it is actually .sconsign_md5.dblite Signed-off-by: Mats Wichmann <mats@linux.com>
* rework the docsWilliam Deegan2022-08-162-16/+33
|
* Added throw_exception parameter to ValidateOptions() which allows you to ↵William Deegan2022-08-152-5/+21
| | | | select either have ValidateOptions() issue error message and exit,or throw an exception and then you can handle it your own way. per dmoody's sugguestion
* add language with instructions what to do if options added by tools are ↵William Deegan2022-08-141-3/+7
| | | | being flagged as undefined. Per mwichmann's feedback
* updates based on mwichmann's comments on the PRWilliam Deegan2022-08-142-5/+5
|
* Add ValidateOption() API which validates that all command line options are ↵William Deegan2022-08-134-4/+26
| | | | either SCons specified or specifie by AddOption calls. It will error out if there are any unknown options. Resolves Issue #4187
* fix a couple typosFlaviu Tamas2022-08-131-3/+3
|
* Fix -fsanitize flag handlingFlaviu Tamas2022-08-131-0/+1
| | | | | | | These parameters need to be passed to both the compiler and the linker, otherwise lots of "undefined reference to `__asan_stack_malloc_0'" errors get emitted at link time, since the appropriate library is not linked in.
View Lorry Controller Status