summaryrefslogtreecommitdiffstats
path: root/doc/generated/functions.gen
Commit message (Collapse)AuthorAgeFilesLines
* Set global lxml etree XSLT maximum traversal depth. Update generated ↵Joseph Brill2022-06-261-25/+27
| | | | documentation artifacts.
* Doc: mention Fortran "dialects"Mats Wichmann2022-06-151-190/+210
| | | | | | | | | | | | | | | | | | | Add to the existing manpage section on Fortran system-specific behavior notes that SCons provides construction environment sets for six "dialects", so that each can be individually tuned based on the file suffix. The PR author considers this system to be of dubious utlity - it only has any real effect in a project with files of many different suffixes where each suffix indicates different handling, within a single build. Since such builds might theoretically exist (there must have been some reason this setup was designed), just try to document what there is. Related in a proximate way only (i.e. next item in manpage), the note on cygwin+Python is amended to also mention msys2. Fixes #4173 Signed-off-by: Mats Wichmann <mats@linux.com>
* Updated docs for 4.2.0 releaseWilliam Deegan2021-11-161-52/+35
|
* Update docs for HOST_OS, TEMPFILE and Split [skip travis] [skip appveyor]Mats Wichmann2021-09-271-30/+35
| | | | | | | | | | | | | | | | | | | | | | The HOST_ARCH/TARGET_ARCH functions have been defined in two places, generic and Windows, these are consolidated into one, leaving a comment in the msvc.xml file to show where that version went to. HOST_OS/TARGET_OS also got some tweaks - this was in line with these now being set by default for all platforms. The $TERMPFILE construction var was not defined; added and the whole family had docs updated. A small tweak to Split wording. References to Python changed to entity references (there are still more of these to change). lambda as an entity reference is not correct (generated docs show the symbol, but Python does not use the lambda symbol to refer to lambda expressions). Signed-off-by: Mats Wichmann <mats@linux.com>
* Fix formatting on ninja example command blockWilliam Deegan2021-07-101-47/+75
|
* Merge branch 'master' into ninja-generationWilliam Deegan2021-07-091-14/+20
|\
| * Update env.Tool behavior and docMats Wichmann2021-05-231-16/+22
| | | | | | | | | | | | | | Review comments suggested for consistency env.Tool should also return the Tool instance. Signed-off-by: Mats Wichmann <mats@linux.com>
* | Updates to docs to indicate experimental statusWilliam Deegan2021-07-081-3/+3
| |
* | Address mwichmann's comments on PR. Mostly doc and a few import related code ↵William Deegan2021-06-011-365/+399
| | | | | | | | changes
* | Fix ninja.xml syntax errorWilliam Deegan2021-06-011-2/+2
|/
* Update generated docs. They were broken [skip appveyor][skip travis]William Deegan2021-04-181-158/+300
|
* update example to simplify map_filename and relocate emitter to after that ↵William Deegan2021-02-261-4/+4
| | | | variable is set as it uses it
* [ci skip]Updated generated docs, Updated docsWilliam Deegan2021-01-151-254/+266
|
* Updated generated doc files and user manual.Dirk Baechle2020-06-201-213/+213
|
* User Guide: update markup for cmdline section [ci skip]Mats Wichmann2020-06-021-425/+464
| | | | | | | | | Update the markup in the cmdline chapter. Also checked in two generated docs which were changed by a couple of earlier changesets. Signed-off-by: Mats Wichmann <mats@linux.com>
* classes no longer explicitly inherit from objectMats Wichmann2020-05-241-2/+17
| | | | | | In Python3 this is the default. Signed-off-by: Mats Wichmann <mats@linux.com>
* [WIP] adjust docbuild for moved src [ci skip]Mats Wichmann2020-05-101-1356/+933
| | | | | | | src/engine/SCons moved to SCons, affects wired in paths in documentation, and doc building scripts Signed-off-by: Mats Wichmann <mats@linux.com>
* Regenerated docs for 3.1.2 releaseWilliam Deegan2019-12-171-566/+653
|
* Merge branch 'master' into py3-doctasksWilliam Deegan2019-12-101-5/+21
|\
| * Merge pull request #3475 from mwichmann/addopt-docsWilliam Deegan2019-12-101-296/+80
| |\ | | | | | | Document that AddOption has limitations
| | * [PR 3475] update docs/generated [ci skip]Mats Wichmann2019-11-161-296/+80
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | There's debated about whether the generated should be checked in at all; without an answer to that, they've fallen far enough out of sync that it becomes harder to use "git diff" as a spot-check that nothing strange is happening due to any given doc change. This should resync them to current. Signed-off-by: Mats Wichmann <mats@linux.com>
* | | [PR 3443] regen all generated files [ci skip]Mats Wichmann2019-12-051-912/+599
| | | | | | | | | | | | | | | | | | | | | | | | Checking in all the examples generated on Ubuntu, which is the default "build platform", to pick up changes caused by a Py3 build. Signed-off-by: Mats Wichmann <mats@linux.com>
* | | Improve building of docs using Py3 [ci skip]Mats Wichmann2019-12-051-5/+5
|/ / | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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>
* | Added support for "-imacros" to ParseFlagsIvan Kravets2019-11-061-5/+6
|/
* Clean up D compiler pagesMats Wichmann2019-08-271-1/+1
| | | | | | | | | | | | | | | | | Manpage duplicated (triplicated, actually) tons of construction variables because they were defined in each of the three possible names for the D compiler. Someone already started a DCommon.xml, this just finishes off the job of moving them there; the individual compiler-name docs now do not define any construction vars. THe ProgramAllAtOnce builder had the same problem, and got the same treatment. Note: lots of the cvars don't actually define the term. I don't use D so I'm not proposing any changes at this time, but it would be simple enough to merge in some simple wording if someone thinks it's important enough. Signed-off-by: Mats Wichmann <mats@linux.com>
* [PR #3423] further wording tweak for Dictionary [ci skip]Mats Wichmann2019-08-251-3/+3
| | | | | | | 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-7/+7
| | | | | | | | | | | | | | | | | | 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>
* Regenerated docs for 3.1.1 release.William Deegan2019-08-081-24/+27
|
* Update docsWilliam Deegan2019-07-141-1/+12
|
* 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>
* [PR #3363] doc update for added flagsMats Wichmann2019-05-041-0/+3
| | | | | | Needed a doc regen to pick up the change. Signed-off-by: Mats Wichmann <mats@linux.com>
* Add textfile tool to defaultsMats Wichmann2019-02-081-0/+4
| | | | | | | | | PR #3242 added the Textfile and Substfile builders to the default builder list (for issue #3147), but didn't finish the job: the textfile tool needs to be added to the default list of tools as well. This time with a testcase that fails if the tool is not added. Minor doc tweak. Signed-off-by: Mats Wichmann <mats@linux.com>
* Regenerated docs for 3.0.2 releaseWilliam Deegan2018-12-311-568/+651
|
* Doc updates. Some issues with generated files, but use for nowWilliam Deegan2018-12-051-651/+568
|
* Resync generated docsMats Wichmann2018-10-031-4/+15
| | | | | | | | There have been a few doc changes since 3.0.1, this commit resyncs the generated docs to pick up fixes and wording. No code or test effect. Signed-off-by: Mats Wichmann <mats@linux.com>
* Fix Bug #2486 - Allow SetOption('silent',True) - Previously this option ↵William Deegan2017-08-201-0/+8
| | | | could not be passed to SetOption
* Added docs for use of the PyPackageDir functiongrbd2017-08-031-0/+25
|
* Update docs to remove deprecated sourcecode toolsWilliam Deegan2017-03-201-176/+0
|
* remove deprecated Perforce toolWilliam Deegan2017-03-201-55/+5
|
* Added help for pull request #226William Deegan2015-09-281-6/+12
|
* - updated generated documentation, prior to release of 2.3.5Dirk Baechle2015-05-201-2/+13
|
* - added doc editor configuration for XXE5Dirk Baechle2014-01-191-1/+1
| | | | | - added missing icons for XXE4 - adapted schema location, such that the validation works properly in SernaFree and XXE
* - added EPUB Builder to the DocBook Tool, based on the work of Andrew ↵Dirk Baechle2013-12-211-0/+22
| | | | Featherstone
* - relinked the build of all documentation outputs to the bootstrap processDirk Baechle2013-05-031-146/+266
| | | | - corrected the doc folder SConscripts and added XSL and titlepage files where required
* - added default files in doc/generated/Dirk Baechle2013-05-031-0/+4978