summaryrefslogtreecommitdiffstats
path: root/doc/user
Commit message (Collapse)AuthorAgeFilesLines
* Dedent some examples in userguide [ci skip]Mats Wichmann2022-07-251-61/+53
| | | | | | | | | | | | The compilation DB examples in the User Guide are indented with the rest of the text (possibly auto-formatting by an editor), while the scons_example and programlisting XML elements respect formatting, so they should actually be dedented. Example code which is not to be displayed (just used to drive the example generation) don't matter so they were left alone this time. Signed-off-by: Mats Wichmann <mats@linux.com>
* [ci skip] Added blurb about ninja restarting the scons daemon if it detects ↵William Deegan2022-06-031-2/+7
| | | | need to regenerate the build.ninja
* Updated ninja docs in users guilde.William Deegan2022-06-021-13/+41
|
* docs: update parseconfig, parseflags, mergeflagsMats Wichmann2022-05-043-48/+51
| | | | | | | | | | | | Docstrings Environment (inc. .backtick) also lightly updated. Functional change: the function to be called by ParseConfig is now passed the *unique* flag, previously omitted (if the default MergeFlags was used, it still picked up this flag but a user-supplied function did not). Added a unit test for user-supplied function. Signed-off-by: Mats Wichmann <mats@linux.com>
* Uguide: fix a typo of environment [ci skip]Mats Wichmann2022-04-191-1/+1
| | | | | | Spotted by @night-ripper on Discord Signed-off-by: Mats Wichmann <mats@linux.com>
* Guide: update Writing Builders chapter [skip appveyor]Mats Wichmann2022-03-191-73/+73
| | | | | | | | | Use entities more consistently. Reword a few things. Text implied that site_init.py needs to be manually imported, adjusted wording not to say so. Signed-off-by: Mats Wichmann <mats@linux.com>
* Updates to User Guide: 22/Caching [skip appveyor]Mats Wichmann2022-03-021-66/+89
| | | | | | | | | | | | Use entities. Adopt the "derived-file cache" terminology used elsewhere instead of the former wording "shared cache". Also added entity references for content/build sigs to manpage, as well as some other entity fiddling. CacheDir entry now mentions SCons doesn't do cache maintenance. Signed-off-by: Mats Wichmann <mats@linux.com>
* Merge pull request #4099 from mwichmann/doc/guide-dependsWilliam Deegan2022-03-021-64/+66
|\ | | | | Updates to User Guide: 6/Dependencies
| * Use entity for content signature [ci skip]Mats Wichmann2022-02-101-7/+7
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * Fix typo Note -> Not [ci skip]Mats Wichmann2022-02-091-1/+1
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * Updates to User Guide: 6/DependenciesMats Wichmann2022-02-091-63/+65
| | | | | | | | | | | | | | | | | | | | Removed most references to md5 and tried to make the terminology used a bit more consistent. Added some markup - refernced functions now hyperlinked on first mention of each section. Signed-off-by: Mats Wichmann <mats@linux.com>
* | Ninja docs (#4105): address some review commentsMats Wichmann2022-02-281-1/+1
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* | Tweaks to ninja docs [skip appveyor]Mats Wichmann2022-02-241-29/+65
|/ | | | | | | | | Rewrite of the intro in the user guide. Otherwise, just markup, formatting, wording tweaks, bigger example of how to install ninja. Signed-off-by: Mats Wichmann <mats@linux.com>
* Docs: Fix a typo and use more entities [skip appveyor]Mats Wichmann2022-02-051-9/+9
| | | | | | | | | | Fixes #4096 (thanks to @Vishwajith-K for reporting) Changed references in this file to use &consvar; and &consenv; entities. + Use the entity for PATH as well. + Update the entity reference for DUMP. Also fix unrelated missing-entity referring to SConscriptChdir method. Signed-off-by: Mats Wichmann <mats@linux.com>
* Refine Uguide variantdir description [skip appveyor]Mats Wichmann2022-01-101-7/+17
| | | | | | Responding to review comment - and going a bit further. Signed-off-by: Mats Wichmann <mats@linux.com>
* Add some info to User Guide on #/paths [skip appveyor]Mats Wichmann2022-01-072-11/+55
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* Update Scanners chapter in User Guide [skip appveyor]Mats Wichmann2021-12-031-60/+66
| | | | | | | | | Just adds a bit more polish, better use of markup, etc. Functionally unchanged. Doc-only change. Signed-off-by: Mats Wichmann <mats@linux.com>
* Update post release changesWilliam Deegan2021-11-221-1/+1
|
* Merge pull request #4049 from mwichmann/java-versionsWilliam Deegan2021-11-111-11/+24
|\ | | | | Update Java support for more versions
| * Add userguide update on javah as wellMats Wichmann2021-11-051-11/+24
| | | | | | | | | | | | Also add more linux locations for Java headers (old saved patch) Signed-off-by: Mats Wichmann <mats@linux.com>
* | Update copyright textWilliam Deegan2021-10-191-20/+22
|/
* Fix a doc typo introduced in PR 4009 [skip appveyor] [skip travis]Mats Wichmann2021-09-071-1/+1
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* userguide preface - a few more tweaks [ci skip]Mats Wichmann2021-09-011-13/+16
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* User Guide: add to Preface [ci skip]Mats Wichmann2021-08-306-48/+70
| | | | | | | Adds a section on "How To Use This Guide", tweaks some other wording. Drop mention of scons-announce list, adds some contact info. Signed-off-by: Mats Wichmann <mats@linux.com>
* [PR #4008] fix an existing typo spotted by sider [ci skip]Mats Wichmann2021-08-291-1/+1
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* Update variables/cli chapter of user guide [ci skip]Mats Wichmann2021-08-291-223/+233
| | | | | | | | | | | | | | | | | | This is really just tweaking, no material changes: the subject of instructions is now consistently "you", and the frequent distinction between the sconscript writer and a seperate category of "users" is emilinated for a cleaner read, and it doesn't say "we" any longer (this distinction is sure to still exist elsewhere in the User Guide). Present tense is also used - there were previously a lot of future tense uses ("will foo"). As usual, some markup stuff is added. doc/scons.mod is condensed a little by making five-line comment blocks into one line, and markup is changed on the three environment variables (<envar> instead of <varname>). Signed-off-by: Mats Wichmann <mats@linux.com>
* Post 4.2.0 merge/reset to development modeWilliam Deegan2021-08-011-2/+2
|
* removed doc/user/copyright.xml the markup is moved ot doc/user/main.xmlWilliam Deegan2021-07-193-44/+7
|
* misc updates to man/users guide copyright formatting. Minor updates to ↵William Deegan2021-07-182-18/+6
| | | | update-release-info to use 'Released: <date here>' instead of range of years.
* Updates to docs to indicate experimental statusWilliam Deegan2021-07-081-13/+22
|
* incremental doc updates to indicate experimental state of ninja builderWilliam Deegan2021-07-071-1/+12
|
* Address mwichmann's comments on PR. Mostly doc and a few import related code ↵William Deegan2021-05-301-245/+276
| | | | changes
* fix broken target check in ninja_execute. It was improperly adding all nodes ↵William Deegan2021-04-131-0/+6
| | | | to NINJA_STATE.add_build(). Instead of only ones which weren't ninja files, nor conftest files
* Incremental checkin. Fleshing out the various env vars used by ninja ↵William Deegan2021-04-131-1/+1
| | | | builders. Also annotated code with some TODO: questions
* [ci skip] Initial doc structure addedWilliam Deegan2021-04-131-20/+36
|
* Added reinstantiatng custom cachedirDaniel Moody2021-04-011-1/+1
|
* fix up some doc issues and add test coverageDaniel Moody2021-04-011-6/+9
|
* Update to add CacheDir arg and address some review comments.Daniel Moody2021-04-011-6/+6
|
* Added custom cachedir class tests and docsDaniel Moody2021-04-011-0/+42
|
* Merge pull request #3877 from mwichmann/emitter-addWilliam Deegan2021-02-264-213/+272
|\ | | | | Adding-emitter example for User Guide
| * update example to simplify map_filename and relocate emitter to after that ↵William Deegan2021-02-261-2/+3
| | | | | | | | variable is set as it uses it
| * [PR #3877] further tweak DefaultEnvironment examples [skip appveyor] [skip ↵Mats Wichmann2021-02-173-21/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | travis] The user guide instances of fiddling ['ENV']['PATH'] in DefaultEnviroment are further updated: they use Dir('.') to add the cwd instead of os.getcwd(). Note all but one of these fiddles were only to make the example generation stuff find a dummy command that was listed in an action but normally wouldn't exist, as it's a placeholder. Those instances are marked with an xml comment now. Signed-off-by: Mats Wichmann <mats@linux.com>
| * If calling DefaultEnviornment, do not call it env [skip appveyor] [skip travis]Mats Wichmann2021-02-163-23/+22
| | | | | | | | | | | | | | | | | | | | Minor niggle: env = Environment() is so ingrained, use a different variable name in the rare places where docs save the result of calling DefaultEnvironment() - denv. Most instances are internal fiddles to add the cwd to PATH for the example generator to work, only two of these actually appear in the visible docs. Signed-off-by: Mats Wichmann <mats@linux.com>
| * [PR #3877] fix some broken examples from initial commit [ci skip]Mats Wichmann2021-02-163-2/+13
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * Adding-emitter example for User Guide [ci skip]Mats Wichmann2021-01-313-203/+254
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Add an example on adding an emitter to an existing builder, based on a mailing-list discussion with Jeremy Elson. Also: * Try to model "best practice" by changing instances of hand-modifying env['ENV']['PATH'] in examples to using AppendENVPath function. * Fixed a couple of Py2-style print statements. * Tweaked markup on a couple of instances of site_scons. * Black-formatted examples in the two userguide sections that were otherwise modified. * Dropped old cons doc content which was included as a big comment at the fromt of builders-writing.xml. Signed-off-by: Mats Wichmann <mats@linux.com>
* | Fix env = Program usage in docs [skip appveyor] [skip travis]Mats Wichmann2021-02-191-1/+2
|/ | | | | | | Two dodgy bits of example code were discovered which do "env = Program(....)", fixed up. Signed-off-by: Mats Wichmann <mats@linux.com>
* Some small doc fiddles [ci skip]Mats Wichmann2021-01-211-10/+11
| | | | | | | | | | | | | | | | * Use os.environ.copy() in examples - better not to get the Python proxy class that is os.environ, and instead a real dict. * Fix spelling on a python dict method: set_default -> setdefault * Update some wording on prepending in the user guide (where it still said "append to the beginning") * Change the rather oblique note in the recently modified section on Append of values to CPPDEFINES with something more explicit. * And, modify the sphinx config to get the version from SCons rather than hardcoding. Fixes #3867 Signed-off-by: Mats Wichmann <mats@linux.com>
* Updated release notes and copyright info for 4.1.0 ReleaseWilliam Deegan2021-01-191-5/+5
|
* [ci skip] update CPPDEFINES to use tuples for -Doff_t=intWilliam Deegan2021-01-192-10/+12
|
* Update doc uses of CCFLAGS to CPPDEFINES [ci skip]Mats Wichmann2021-01-162-10/+14
| | | | | | | | After discussion, it seemed like we should set a proper example, so the Append and Prepend examples that used *FLAGS to set a -Dstring value now use CPPDEFINES (without the -D). Signed-off-by: Mats Wichmann <mats@linux.com>
generated by cgit v0.12 at 2024-11-28 11:15:26 (GMT)