summaryrefslogtreecommitdiff
path: root/doc/generated/examples
Commit message (Collapse)AuthorAgeFilesLines
* Regenerated docs for 4.5.2 release.William Deegan2023-03-211-3/+3
|
* Regenerated docs for 4.5.1 releaseWilliam Deegan2023-03-061-3/+3
|
* Regenerated docs for 4.5.0 release.William Deegan2023-03-055-6/+22
|
* rework the docsWilliam Deegan2022-08-161-3/+3
|
* Added throw_exception parameter to ValidateOptions() which allows you to ↵William Deegan2022-08-151-3/+3
| | | | 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
* updates based on mwichmann's comments on the PRWilliam Deegan2022-08-141-3/+3
|
* Add ValidateOption() API which validates that all command line options are ↵William Deegan2022-08-132-4/+4
| | | | either SCons specified or specifie by AddOption calls. It will error out if there are any unknown options. Resolves Issue #4187
* Updated autogenerated doc filesWilliam Deegan2022-07-3010-14/+16
|
* Add some info to User Guide on #/paths [skip appveyor]Mats Wichmann2022-01-071-0/+5
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* 4.3.0 updates4.3.0William Deegan2021-11-171-2/+2
|
* updated CHANGES.txt and RELEASE.txt for releaseWilliam Deegan2021-11-161-1/+1
|
* Updated docs for 4.2.0 releaseWilliam Deegan2021-11-165-12/+11
|
* Regenerated docs for X.Y.Z release.William Deegan2021-07-311-1/+1
|
* updated docsWilliam Deegan2021-07-231-2/+2
|
* Regenerated docs for 4.2.0 release.William Deegan2021-07-232-2/+2
|
* Fix formatting on ninja example command blockWilliam Deegan2021-07-094-11/+11
|
* Fix broken markup, regenerate filesWilliam Deegan2021-07-091-2/+2
|
* Updates to docs to indicate experimental statusWilliam Deegan2021-07-071-2/+2
|
* Address mwichmann's comments on PR. Mostly doc and a few import related code ↵William Deegan2021-05-305-8/+8
| | | | changes
* Update generated docs. They were broken [skip appveyor][skip travis]William Deegan2021-04-187-8/+10
|
* update example to simplify map_filename and relocate emitter to after that ↵William Deegan2021-02-263-5/+5
| | | | variable is set as it uses it
* [PR #3877] fix some broken examples from initial commit [ci skip]Mats Wichmann2021-02-164-24/+0
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* Adding-emitter example for User Guide [ci skip]Mats Wichmann2021-01-311-0/+13
| | | | | | | | | | | | | | | | | | 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>
* Regenerated docs for 4.1.0 releaseWilliam Deegan2021-01-194-6/+6
|
* [ci skip]Updated generated docs, Updated docsWilliam Deegan2021-01-156-10/+12
|
* Adjust CompilationDatase documentation [skip appveyor]Mats Wichmann2020-12-232-0/+8
| | | | | | | | | Try to be a bit more descriptive about compilation databases. Two of the User Guide examples now use the scons_examples style to show a little more what happens. Fixes #3845. Signed-off-by: Mats Wichmann <mats@linux.com>
* Tweaks to variant dir documentation [skip appveyor]Mats Wichmann2020-09-211-0/+2
| | | | | | | | | | | | | | | | | | | Manpage/shared VariantDir function wording tries to make more clear that build happens in the variant. Other tweaking. User guide variant description similarly updated. A (worded) example of why one might want variants is added. Formerly separate chapter doc/user/variants.xml is now included as a section in the previous chapter. An additional example is enabled (was in the file but commented out), which some introductiory wording. The introduction to the other sample in the file is also built up slightly. Dropped embedded comments that were the old Cons documentation for these topics. Signed-off-by: Mats Wichmann <mats@linux.com>
* Merge pull request #3791 from mwichmann/sideeffectWilliam Deegan2020-09-192-1/+5
|\ | | | | Include SideEffect section into the UserGuide
| * Include SideEffect section into the UserGuide [skip appveyor]Mats Wichmann2020-09-042-1/+5
| | | | | | | | | | | | | | Existing written doc, but was not included - now added to the Miscellaneous chapter. Some rewriting. Signed-off-by: Mats Wichmann <mats@linux.com>
* | More clarification and fixes on Variables [skip appveyor]Mats Wichmann2020-09-177-8/+14
|/ | | | | | | | | | | | | | | | | | | | | | Add note to manpage that Variables names should not conflict with existing constructions variables. Fix a broken User Guide example which was hitting a Py2/Py3 transition - was displaying "Unknown variables: dict_keys(['NOT_KNOWN'])" instead of "Unknown variables: NOT_KNOWN" Added a User Guide note on how to make sure a Variable is actually supplied, if that's what you want (making the default an invalid value). This is supported by an additional output of an existing example (it's not a new example, just called a different way). Slightly built up the explanation of UnknownVariables not being usable until variables object has been passed to an env. Examples reformatted using Black, which changed some line numbers in example outputs. Signed-off-by: Mats Wichmann <mats@linux.com>
* and fix a "thinko" in new userguide example [skip appveyor]Mats Wichmann2020-08-281-1/+1
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* Updated docs on Actions for output controlMats Wichmann2020-08-281-0/+3
| | | | | | | | | | | | | Manpage now mentions specifically generating your own Action object in order to control the output string. Calls out using None as the command-output specifier to avoid output: Action(foo, None) and Action(foo, cmdstr=None), as well Userguide got a mention of using the action kwarg for readability and an example showing creating the Action for Command manually to set the output string. Signed-off-by: Mats Wichmann <mats@linux.com>
* [PR #3752] guide: update consvar setting after review [skip appveyor]Mats Wichmann2020-07-232-0/+9
| | | | | | | | | | | | | | | | Review comments noted that there was perhaps more assumptions about Python knowledge than warranted, added some things to address that, including an intro to dictionaries. Markup changes in environment chapter, plus more wording tweaks. Filled out an example of of overriding when calling a builder, and added a note on when that is not sufficient, and separate envs are needed. Dropped a python2 paragraph. Signed-off-by: Mats Wichmann <mats@linux.com>
* Update docs on argument passing to Environment, etc.Mats Wichmann2020-07-222-0/+8
| | | | | | | | Adds a new uguide Ch 7 section on using the parse_flags method (with Ex.) Moves the section on overrides in calls to Builders to Chap 7 - it was using concepts not introduced yet where it was placed. Signed-off-by: Mats Wichmann <mats@linux.com>
* Regenerated docs for 4.0.1 ReleaseWilliam Deegan2020-07-161-2/+2
|
* Updated generated doc files for 4.0.0William Deegan2020-07-042-4/+4
|
* Add sepearat pypi README-package.rst for pypi's long description textWilliam Deegan2020-07-043-5/+5
|
* Updated generated doc files and user manual.Dirk Baechle2020-06-201-7/+2
|
* Documentation updates in perparation for 4.0 [ci skip]Mats Wichmann2020-06-10230-237/+237
| | | | | | | | | | | | | * Switch API docs to readthedocs theme * Add links in manpage SEE ALSO to external websites. These are not just live, but also listed out (Linux manpages won't have the hyperlinks) * Links use docbook5 xlink:href instead of deprecated (claimed to be removed, but apparently not) ulink syntax * Comment out manpage Examples section, and leave a pointer to scons-cookbook.readthedocs.io instead * Regenerate everything, mainly to pick up compilation_db stuff. Signed-off-by: Mats Wichmann <mats@linux.com>
* docs src-move: remove debug prints [ci skip]Mats Wichmann2020-05-101-2/+2
| | | | | | | | | accidentally left print statements in bin/scons-proc.py rebased to current master, which caused a couple of generated file changes. Signed-off-by: Mats Wichmann <mats@linux.com>
* [WIP] adjust docbuild for moved src [ci skip]Mats Wichmann2020-05-10222-470/+270
| | | | | | | src/engine/SCons moved to SCons, affects wired in paths in documentation, and doc building scripts Signed-off-by: Mats Wichmann <mats@linux.com>
* Merge pull request #3615 from mwichmann/doc-cmdline-varsWilliam Deegan2020-04-212-11/+18
|\ | | | | docs: update Variables content
| * docs: update Variables content [ci skip]Mats Wichmann2020-04-172-11/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Apply current formatting styles for funcs/methods (that is, func/method name is marked up, instance name is marked up, params are marked up, each with the appropriate docbook tag. * Word around the obsolete reference to built-in cmp function, which no longer exists in Python 3. We should probably transtion the API towards taking a key function instead, since that conversion is already done internally. * Clarify the way AddVariables is described - it takes a list of tuples, but that "list" isn't a Python list object, but rather one or more tuples, varargs-style. Also describe the content of the tuples. * Tweak some other wordings on variable helpers and validators. * Rework userguide chapter examples to use keyword arguments for calls to Add and for the *Variable functions. * Add a User Guide example of a help message that is more than a simple one (reuses an EnumVariable example) to illustrate that the generated help text is more than the help=helpstring. * Word differently the back-reference to Options in the User Guide. Signed-off-by: Mats Wichmann <mats@linux.com>
* | SConsExamples: drop bootstrap reference [ci skip]Mats Wichmann2020-04-192-6/+30
|/ | | | | | | | | | bootstrap directory not used any longer, dropped. One generated example (troubleshoot_stacktrace) was directly affected. A different generated troubleshooting example was instroduced by an earlier change but never committed, including here for completeness. Signed-off-by: Mats Wichmann <mats@linux.com>
* Add option to use box-draw chars with --treeMats Wichmann2020-03-245-85/+86
| | | | | | | | | | | | | | This picks up and hopefully completes PR #3560. Add documentation for new --tree "linedraw" option. There is a new example output in userguide, which renumbers several of the existing troubleshoot_tree example outputs. Test is cleaned up a bit (not just the added part). The actual function in Util is made a little more genral - it uses unicode chr() values instead of literally pasting in the line drawing characters. Signed-off-by: Mats Wichmann <mats@linux.com>
* Regenerated docs for 3.1.2 releaseWilliam Deegan2019-12-17232-271/+483
|
* [PR 3443] regen all generated files [ci skip]Mats Wichmann2019-12-05232-486/+273
| | | | | | | | 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-041-1/+1
| | | | | | | | | | | | | | | | | | | | * 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>
* Merge branch 'master' into remove_aegis_bits_issue_2639William Deegan2019-09-073-34/+35
|\
| * Fix xml entity generation in examples [ci skip]Mats Wichmann2019-09-074-38/+38
| | | | | | | | | | | | | | | | Closes #3003: those examples which wanted to generate a phony address for a Python object were doing so incorrectly, causing output to end up with &amp;gt; instead of &gt;. Signed-off-by: Mats Wichmann <mats@linux.com>
View Lorry Controller Status