summaryrefslogtreecommitdiffstats
path: root/doc/man
Commit message (Collapse)AuthorAgeFilesLines
* update some doc copyright dates/formattingWilliam Deegan2020-07-042-5/+9
|
* [PR #3730] fix doc syntax errors [skip appveyor]Mats Wichmann2020-07-031-1/+1
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* sconsign man: fix missing para markup [ci skip]Mats Wichmann2020-07-021-0/+2
| | | | | | | Earlier change to update SEE ALSO section dropped some required markup. Signed-off-by: Mats Wichmann <mats@linux.com>
* Apply formatting preferences to sconsign man [ci skip]Mats Wichmann2020-07-011-49/+88
| | | | | | | The sconsign manpage hasn't received the same update to formatting styles as scons, do that. Minimal content change. Signed-off-by: Mats Wichmann <mats@linux.com>
* [PR #3713] tweak manpage per review commentsMats Wichmann2020-06-251-4/+12
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* A bit of tweaking on Action Objects in manpage [ci skip]Mats Wichmann2020-06-241-82/+75
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* Fix docbook 4.5 vs 5 usage [ci skip]Mats Wichmann2020-06-171-6/+5
| | | | | | | | | | | | | | | | Recent changes introduced the use of the Docbook 5 syntax for external links (<link xlink:href="https://www.example.com"/>), which works okay for the doc build, but breaks the internal tools which do formal validation against the scons-modified docbook DTD ("sconsdoc") because sconsdoc is a modification of Docbook 4.5 thus pinning us to that version. xlink was a Docbook 5 introduction to use more standard W3C syntax for the links (xlink is a W3C spec of its own). Back off this new usage: go back to the old usage pattern (<ulink url="https://www.example.com">), because trying to uplift sconsdoc looks a fairly substantial task. Signed-off-by: Mats Wichmann <mats@linux.com>
* Documentation updates in perparation for 4.0 [ci skip]Mats Wichmann2020-06-101-5/+28
| | | | | | | | | | | | | * 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>
* Merge pull request #3676 from mwichmann/manpage-extendingWilliam Deegan2020-06-011-161/+112
|\ | | | | Update manpage Extending section
| * [PR #3676] fix doc typo detected by sider [ci skip]Mats Wichmann2020-05-311-1/+2
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * Update manpage Extending section [ci skip]Mats Wichmann2020-05-311-162/+114
| | | | | | | | | | | | | | | | | | | | Extending SCons: this is mainly syntax: adding/adjusting markup, reformatting code examples, adding the word "Example:" in a few places, moving a paragraph outside a list since it applies to the whole list, not to the last item of the list. A list is reformatted to a <simplelist> for a shorter layout. Signed-off-by: Mats Wichmann <mats@linux.com>
* | Merge pull request #3677 from mwichmann/manpage-examplesWilliam Deegan2020-06-011-99/+119
|\ \ | | | | | | Update manpage Examples section
| * | Update manpage Examples section [ci skip]Mats Wichmann2020-05-311-99/+119
| |/ | | | | | | | | | | | | Examples: mainly syntax: adding/adjusting markup, reformatting code examples, etc. Signed-off-by: Mats Wichmann <mats@linux.com>
* | Merge pull request #3678 from mwichmann/manpage-configfileWilliam Deegan2020-05-311-129/+147
|\ \ | | | | | | Update manpage Configuration File section
| * | Update manpage Configuration File section [ci skip]Mats Wichmann2020-05-311-129/+147
| |/ | | | | | | | | | | | | | | | | | | | | | | | | CONFIGURATION FILE REFERENCE: markup added/updated, examples reformatted. A chunk of text followed the included "GENERATED CONSTRUCTION VARIABLE DESCRIPTIONS" which describes how to access consvars, this was moved before the inclusion for better flow. A bit was added to the final paragraph before that inclusion to remind that actual consvars are based on which tools were actually able to initialize. Signed-off-by: Mats Wichmann <mats@linux.com>
* | Update manpage Options section [ci skip]Mats Wichmann2020-05-311-58/+71
|/ | | | | | | OPTIONS: add/change markup. A few comments modified on CacheDir usage, and on Help. Dropped a reference to SCCS/RCS retrieval. Signed-off-by: Mats Wichmann <mats@linux.com>
* classes no longer explicitly inherit from objectMats Wichmann2020-05-241-5/+5
| | | | | | 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-104-5/+6
| | | | | | | src/engine/SCons moved to SCons, affects wired in paths in documentation, and doc building scripts Signed-off-by: Mats Wichmann <mats@linux.com>
* mapage: update markup in Node section [ci skip]Mats Wichmann2020-05-061-16/+16
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* Tweaks to manpage special modifiers wording [ci skip]Mats Wichmann2020-05-031-1/+22
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* manpage: tweaks to EXTENDING SCONS section [ci skip]Mats Wichmann2020-04-301-317/+270
| | | | | | | | | | | | | * Lots of markup changes * Some wording changes. * Some lists compacted into <simplelist> instead of <variablelist> when it didn't need necessary to have linfeed+intent following the term. That is, using the inline style: term - descriptiong of term * Several inline lists of arguments to passed functions were broken out into <simplelist> for better readability. Signed-off-by: Mats Wichmann <mats@linux.com>
* Fix typo "seperator" caught by sider [ci skip]Mats Wichmann2020-04-231-1/+1
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* docs: update Tool description [ci skip]Mats Wichmann2020-04-231-51/+104
| | | | | | | | | | | Tools is now is own subsection of Construction Environments, with an expanded description, also slightly reorganizing existing content. The description of the Tool function/method was also reworded to be more descriptive and less repetitive. Signed-off-by: Mats Wichmann <mats@linux.com>
* Merge pull request #3615 from mwichmann/doc-cmdline-varsWilliam Deegan2020-04-211-181/+185
|\ | | | | docs: update Variables content
| * [PR #3615] address some review comments on Variables [ci skip]Mats Wichmann2020-04-201-8/+8
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * docs: update Variables content [ci skip]Mats Wichmann2020-04-171-178/+182
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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>
* | Docs: update the Configure Context sections [ci skip]Mats Wichmann2020-04-171-276/+289
|/ | | | | | | | Apply new formatting styles. Tweak a lot of wordings. Make sure manpage consistently describes return types. Signed-off-by: Mats Wichmann <mats@linux.com>
* [PR #3612] doc update: cvars are <envar> [ci skip]Mats Wichmann2020-04-161-37/+34
| | | | | | | | | | Consider construction variable as environment variables, using that markup in scons.xml and generating it into the variables.gen file (which is included in man and userguide). If possible, use the entity from variables.mod, which already has the envar markup generated. Signed-off-by: Mats Wichmann <mats@linux.com>
* Update markup on TARGETS, SOURCES, ARGUMENTS [ci skip]Mats Wichmann2020-04-161-51/+55
| | | | | | | | | | | | | | | | Use <varname> to mark up variables in these three areas, also a few other variables that were marked up differently. Sometimes that markup comes in the form of using an existing entity (&BUILD_TARGETS; for example), which is already suitably marked up in the entity definition. Use <parameter> to mark up when they're in the context of function params. The parse_flags kwarg now includes a link to the env.ParseFlags method, since the latter describes how the args are distributed. Signed-off-by: Mats Wichmann <mats@linux.com>
* Update generation of scons-xml entities [ci skip]Mats Wichmann2020-04-161-1/+7
| | | | | | | | | | | | | | | | | | | | | | PR #3602 introduced a new problem - the documents that include the generated functions and builders files now don't validate. The global function/environment method name was bolded by using <emphasis>, but Docbook doesn't allow that inside a <literal> element (it actually works fine with the processing tools we use, but does fail validation). Rework the idea: use <function> and <methodname> for the markup, and change the way those are rendered in html (man/html.xsl and user/html.xsl) - the PDF already rendered these in bold so no change needed there. Also don't wrap the whole contents of the <term> element in <literal>, which would have left the argument list in regular font which the function name and instance name in monospace - an odd look. So the argument list was wrapped in <parameter>, since that's what they are. Don't bother to try to parse it down into individual args, just do the whole chunk, less the parentheses. Signed-off-by: Mats Wichmann <mats@linux.com>
* Merge pull request #3597 from mwichmann/man-tweaks-scanobjWilliam Deegan2020-03-291-44/+42
|\ | | | | manpage: new markup on Scanner Objects
| * manpage: new markup on Scanner Objects [ci skip]Mats Wichmann2020-03-291-44/+42
| | | | | | | | | | | | Apply improved markup and add some links for Scanner Objects Signed-off-by: Mats Wichmann <mats@linux.com>
* | Update doc intro section; mention pywin32 [ci skip]Mats Wichmann2020-03-291-8/+10
|/ | | | | | | | | Slight wording change to program locations. Move requirements paragraph to last in section, and mention pywin32 is recommended on Windows. Signed-off-by: Mats Wichmann <mats@linux.com>
* Further wordsmithing on configure contexts [ci skip]Mats Wichmann2020-03-271-82/+91
| | | | | | | Address review comment (PR #3593) and clean up some markup issues and ordering. Signed-off-by: Mats Wichmann <mats@linux.com>
* Improve manpage treatment of Variables and ConfigureMats Wichmann2020-03-264-270/+314
| | | | | | | | | | | | | | | | | | Various cleansup to sections Configure Contexts, Command-Line Construction Variables and SConscript Variables. Stylesheet-level changes place multiple function signature entries each on their own line (affects primarily Configure Contexts). A couple of stylesheet files were checked in in DOS format, changed them to the same as the rest of the codebase (this shows lots of spurious diff). Discovered a few minor tweaks to make to code implementing the above, so this is not completely doc-only. Signed-off-by: Mats Wichmann <mats@linux.com>
* [PR #3591] tweak --tree=linedrawMats Wichmann2020-03-241-0/+1
| | | | | | | | Add version note to manpage Turn linedraw chars into module-level constants, and use in the other place it was hardcoded. Signed-off-by: Mats Wichmann <mats@linux.com>
* Add option to use box-draw chars with --treeMats Wichmann2020-03-241-1/+14
| | | | | | | | | | | | | | 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>
* Make the manpage option-choice treatement consistent [ci skip]Mats Wichmann2020-03-231-148/+124
| | | | | | | | All the options where the option-argument is a choice between several (and possibly a choice of several, comma-separated) now are rendered in the same way. Signed-off-by: Mats Wichmann <mats@linux.com>
* Improve manpage markup on options [ci skip]Mats Wichmann2020-03-221-134/+315
| | | | | | The definition of options is now marked up with Docbook option tags. Signed-off-by: Mats Wichmann <mats@linux.com>
* [PR #3583] fix a couple of review commentsMats Wichmann2020-03-131-3/+3
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* Sider spotted a long-standing doc spelling mistake [ci skip]Mats Wichmann2020-03-131-1/+1
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* Continue manpage cleanups [ci skip]Mats Wichmann2020-03-121-1046/+1013
| | | | | | | | | | | | | | | | | | | | | | | | | | | Eliminate some "note" wording in manpage. This is a "tone" thing, trying to avoid so many "asides", like "Note that blah blah", by trying to reword into a more regular flow, and occasionally dropping the aside if it doesn't seem quite suited to the manpage. More harmonization of docbook entity usage, cleanup of comments around generated sections, and other fiddling. <literallayout> around a code fragment was changed to <programlisting> <literallayout> around output was changed to <screen> If a <screen> section contained use input, that was marked with the <userinput> entity. These changes ought to also facilitate better conversion to other document markup formats, something which has been discussed. In the Description section, the remaining command-line discussion at the end was merged into the earlier wording about command-line processing, to improve the flow a bit. Some options entries were adjusted for appearance - indents, etc. Mention of Python 2.7 as a requirement is dropped. Signed-off-by: Mats Wichmann <mats@linux.com>
* More manpage fiddling [ci skip]Mats Wichmann2020-01-251-261/+247
| | | | | | | | | | | | | | | | Add 2020 year. Use entities in more places where such are already defined. Change more instances of option formatting so the line break is between </listitem> and <listitem> Commented out options (not implemented) are not inside a <listitem> block. A few other markup bits and indentations. Most of this does not show in the built manpage. Also amplified a few descriptions. Signed-off-by: Mats Wichmann <mats@linux.com>
* Merge pull request #3501 from mwichmann/man-introWilliam Deegan2020-01-131-158/+160
|\ | | | | Update manpage intro section
| * [PR #3501] review - modify site_scons description [ci skip]Mats Wichmann2019-12-201-12/+15
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * Update manpage intro section [ci skip]Mats Wichmann2019-12-201-154/+153
| | | | | | | | | | | | | | | | | | Side effect: added an entry to scons.mod for the sconscript function (it didn't have one since the name itself was already in use). Change the type of a few entities. Those changes don't have a content effect, just a presentation effect. Signed-off-by: Mats Wichmann <mats@linux.com>
* | [ci skip] minor fixups on PR #3522William Deegan2020-01-111-2/+2
| |
* | Clean up some manpage duplication, File, DirMats Wichmann2020-01-101-79/+66
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Removed some dupes in the Construction Variables section - the JAR entries plus File, Dir. Tweaked the File and Dir function entries, and the File and Directory Nodes section. The end-to-end tests for File and Dir didn't test the case of supplying a list-of-strings (thus returning a list-of-nodes) to those two functions, added a primitive one. Signed-off-by: Mats Wichmann <mats@linux.com>
* | [PR #3511] extra -C test was not needed, dropMats Wichmann2019-12-291-11/+18
| | | | | | | | | | | | | | | | Instead of fixing for PY2, just drop the test: turns out the existing 5th testcase covers it adequately. Leave a bit of a commen trail though. Signed-off-by: Mats Wichmann <mats@linux.com>
* | Clarify behavior of -C option plus speedupsMats Wichmann2019-12-291-22/+16
|/ | | | | | | | | | | | Manpage now indicates that the additive behavior of multiple -C options applies only to non-absolute paths. A test for a -C absolute-path is added. Along the way this and several other option flag testcases were sped up through the tools=[] trick. On the Windows box under test, these changes took 150 seconds off a (non-parallel) test run. Signed-off-by: Mats Wichmann <mats@linux.com>
generated by cgit v0.12 at 2025-04-06 01:21:50 (GMT)