summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* | classes no longer explicitly inherit from objectMats Wichmann2020-05-245-10/+25
|/ | | | | | In Python3 this is the default. Signed-off-by: Mats Wichmann <mats@linux.com>
* doc generation: fix another src->SCons transitionMats Wichmann2020-05-115-91/+59
| | | | | | | Another regen of generated files, as there were a couple of changes that affected those. Signed-off-by: Mats Wichmann <mats@linux.com>
* docs src-move: remove debug prints [ci skip]Mats Wichmann2020-05-102-5/+7
| | | | | | | | | 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>
* Some more adjustments to doc build [ci skip]Mats Wichmann2020-05-102-72/+126
| | | | | | | | | | other changes due to path changes rewording in doc howto rst check in the doc flow image used by the howto, as it's tricky to generate Signed-off-by: Mats Wichmann <mats@linux.com>
* [WIP] adjust docbuild for moved src [ci skip]Mats Wichmann2020-05-10248-5911/+5741
| | | | | | | 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>
* docs: fix typos from siderMats Wichmann2020-04-281-1/+1
| | | | Signed-off-by: Mats Wichmann <mats@linux.com>
* docs: tweak Export wording a bit more [ci skip]Mats Wichmann2020-04-281-25/+44
| | | | | | Be more clear in response to a review comment. Signed-off-by: Mats Wichmann <mats@linux.com>
* Exports doc fixes [ci skip]Mats Wichmann2020-04-261-2/+2
| | | | | | | | | Fix a couple of typos discoverted by sider. Update doc entries in the (shared) function descriptions of Export, Import and Return (Environment.xml) Signed-off-by: Mats Wichmann <mats@linux.com>
* docs: build up description of export/import/return [ci skip]Mats Wichmann2020-04-251-44/+97
| | | | | | | User Guide wording missed some details - one of which is mentioned in an issue. Fixes #798. 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-214-312/+346
|\ | | | | docs: update Variables content
| * [PR #3615] address some review comments on Variables [ci skip]Mats Wichmann2020-04-202-9/+9
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * docs: update Variables content [ci skip]Mats Wichmann2020-04-174-309/+343
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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>
* | Merge pull request #3617 from mwichmann/doc-examples-scriptsWilliam Deegan2020-04-202-6/+30
|\ \ | | | | | | Fix one more instance of moved scons.py
| * | 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>
* | Docs: update the Configure Context sections [ci skip]Mats Wichmann2020-04-172-317/+343
|/ | | | | | | | 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>
* Merge pull request #3613 from mwichmann/func-html-fmtWilliam Deegan2020-04-162-3/+14
|\ | | | | Update generation of scons-xml entities
| * Update generation of scons-xml entities [ci skip]Mats Wichmann2020-04-162-3/+14
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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 #3603 from bdbaddog/revamp_scons_buildWilliam Deegan2020-04-161-125/+59
|\ \ | |/ |/| Revamp scons build - Modernize packaging and purge obsolete build logic
| * Disable generating API docs for now epydoc is unmaintained and (?) not ↵William Deegan2020-04-091-1/+1
| | | | | | | | working with py3. Need to switch to sphinx(?)
| * Fix doc sconscriptWilliam Deegan2020-04-091-1/+1
| |
| * comment out packaging part of buildWilliam Deegan2020-04-091-1/+1
| |
| * First pass of refactor. Moved command line argument processing into ↵William Deegan2020-04-091-3/+3
| | | | | | | | site_scons/BuildCommandLine.py. Sorted out all changes caused by that.
| * add SKIP_DOC= variable to enable disabling buildign documents. Moved epydoc ↵William Deegan2020-04-091-120/+54
| | | | | | | | setup into site_scons/epydoc.py
* | Manpage example tweaks [ci skip]Mats Wichmann2020-04-073-6/+6
|/ | | | | | | | | | | | | | | | | A set of minor changes to various extra files (i.e. not scons.xml itself). Mainly this reformats some example code when it looked bad in a fixed-width version (pdf or Linux-style manpage). Also: additional wording on default environment (included here because file was being modified anyway), and define an entity for default env. in doc/scons.mod. Commits changes to two generated .mod files to make sure entities list is correct even if even if a full regen of these files (bin/docs-update-generated) is not done. 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-268-503/+550
| | | | | | | | | | | | | | | | | | 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-247-91/+118
| | | | | | | | | | | | | | 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>
* Merge pull request #3583 from mwichmann/man-notesWilliam Deegan2020-03-154-1051/+1031
|\ | | | | Continue manpage cleanups
| * [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-124-1052/+1032
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* | Some user guide tweaks [ci skip]Mats Wichmann2020-03-123-65/+97
|/ | | | | | | | | | | | troubleshooting and caching sections got some improvements to the xml entities used, mainly for options. A few wording tweaks as well. added a blurb to troublseshooting to urge looking for simpler answers. scons.mod - options section changes to use <option> markup. Signed-off-by: Mats Wichmann <mats@linux.com>
* rm-py2: Remove "from __future__" from more placesMats Wichmann2020-02-202-14/+8
| | | | | | | | | | | | | | | A couple of minor reformats along the way, most prominently, in tests, if being edited anyway, make sure the docstring most tests have is actually the docstring (sometimes the __revision__ line came before, which makes the string not be the docstring). Snuck in some minor framework changes that were orphaned when another draft PR was not needed: this almost all docstring changes, the functional part is using casefold instead of lower in a match func - a slightly better approach which is now possible that Py2 compatibility is not needed. Signed-off-by: Mats Wichmann <mats@linux.com>
* Fix some py3.8 warnings in doc SConscriptWilliam Deegan2020-02-171-2/+3
|
* Merge pull request #3533 from mwichmann/more-doc2William Deegan2020-02-059-91/+148
|\ | | | | Another round of user guide fiddling
| * [PR #3533] fix typo [ci skip]Mats Wichmann2020-02-051-1/+1
| | | | | | | | Signed-off-by: Mats Wichmann <mats@linux.com>
| * Another round of user guide fiddling [ci skip]Mats Wichmann2020-01-249-91/+148
| | | | | | | | | | | | Some markup changes, a few werding additions. Signed-off-by: Mats Wichmann <mats@linux.com>
generated by cgit v0.12 at 2025-04-17 11:14:34 (GMT)