summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMats Wichmann <mats@linux.com>2023-02-23 10:15:26 -0700
committerMats Wichmann <mats@linux.com>2023-02-23 10:15:26 -0700
commit7923bb984986831f6696ae966e3297cce7e96316 (patch)
treeb090e062cc6b81e2e47a7875b3815ac603381d7c
parent959e35788a8a6aa418c97cb55221c70b9cc15fe5 (diff)
downloadscons-git-7923bb984986831f6696ae966e3297cce7e96316.tar.gz
UGuide; tweak Scanner intro again [skip appveyor]
Put back the previous wording, now with glossary entry that also defines the plural form Scanners (there is still no actual glossary) Signed-off-by: Mats Wichmann <mats@linux.com>
-rw-r--r--doc/scons.mod13
-rw-r--r--doc/user/builders-writing.xml3
-rw-r--r--doc/user/scanners.xml3
3 files changed, 13 insertions, 6 deletions
diff --git a/doc/scons.mod b/doc/scons.mod
index ebe0e6f48..2d3f5a434 100644
--- a/doc/scons.mod
+++ b/doc/scons.mod
@@ -92,15 +92,23 @@
<!ENTITY zip "<application xmlns='http://www.scons.org/dbxsd/v1.0'>zip</application>">
+<!-- Concepts: these are key SCons things, which may *also* be classes, etc.
+ but are marked here for inclusion in a glossary
+-->
+<!ENTITY Action "<glossterm linkend='gls-action' xmlns='http://www.scons.org/dbxsd/v1.0'>Action</glossterm>">
+<!ENTITY Builder "<glossterm linkend='gls-builder' xmlns='http://www.scons.org/dbxsd/v1.0'>Builder</glossterm>">
+<!ENTITY Builders "<glossterm linkend='gls-builder' xmlns='http://www.scons.org/dbxsd/v1.0'>Builders</glossterm>">
+<!ENTITY Scanner "<glossterm linkend='gls-scanner' xmlns='http://www.scons.org/dbxsd/v1.0'>Scanner</glossterm>">
+<!ENTITY Scanners "<glossterm linkend='gls-scanner' xmlns='http://www.scons.org/dbxsd/v1.0'>Scanners</glossterm>">
+
+
<!-- Classes. -->
-<!ENTITY Action "<classname xmlns='http://www.scons.org/dbxsd/v1.0'>Action</classname>">
<!ENTITY ActionBase "<classname xmlns='http://www.scons.org/dbxsd/v1.0'>ActionBase</classname>">
<!ENTITY BuildInfo "<classname xmlns='http://www.scons.org/dbxsd/v1.0'>BuildInfo</classname>">
<!ENTITY CommandAction "<classname xmlns='http://www.scons.org/dbxsd/v1.0'>CommandAction</classname>">
<!ENTITY FunctionAction "<classname xmlns='http://www.scons.org/dbxsd/v1.0'>FunctionAction</classname>">
<!ENTITY ListAction "<classname xmlns='http://www.scons.org/dbxsd/v1.0'>ListAction</classname>">
-<!ENTITY Builder "<glossterm xmlns='http://www.scons.org/dbxsd/v1.0'>Builder</glossterm>">
<!ENTITY BuilderBase "<classname xmlns='http://www.scons.org/dbxsd/v1.0'>BuilderBase</classname>">
<!ENTITY CompositeBuilder "<classname xmlns='http://www.scons.org/dbxsd/v1.0'>CompositeBuilder</classname>">
<!ENTITY MultiStepBuilder "<classname xmlns='http://www.scons.org/dbxsd/v1.0'>MultiStepBuilder</classname>">
@@ -110,7 +118,6 @@
<!ENTITY Parallel "<classname xmlns='http://www.scons.org/dbxsd/v1.0'>Parallel</classname>">
<!ENTITY Node "<classname xmlns='http://www.scons.org/dbxsd/v1.0'>Node</classname>">
<!ENTITY Node_FS "<classname xmlns='http://www.scons.org/dbxsd/v1.0'>Node.FS</classname>">
-<!ENTITY Scanner "<glossterm xmlns='http://www.scons.org/dbxsd/v1.0'>Scanner</glossterm>">
<!ENTITY Sig "<classname xmlns='http://www.scons.org/dbxsd/v1.0'>Sig</classname>">
<!ENTITY Signature "<classname xmlns='http://www.scons.org/dbxsd/v1.0'>Signature</classname>">
<!ENTITY Taskmaster "<classname xmlns='http://www.scons.org/dbxsd/v1.0'>Taskmaster</classname>">
diff --git a/doc/user/builders-writing.xml b/doc/user/builders-writing.xml
index a53e70e07..97ca36f9f 100644
--- a/doc/user/builders-writing.xml
+++ b/doc/user/builders-writing.xml
@@ -222,13 +222,14 @@ hello.c
To be able to use both our own defined &Builder; objects
and the default &Builder; objects in the same &consenv;,
you can either add to the &cv-link-BUILDERS; variable
- using the &Append; function:
+ using the &f-link-Append; function:
</para>
<scons_example name="builderswriting_ex3">
<file name="SConstruct">
import os
+
env = Environment()
env.AppendENVPath('PATH', os.getcwd())
bld = Builder(action='foobuild &lt; $SOURCE &gt; $TARGET')
diff --git a/doc/user/scanners.xml b/doc/user/scanners.xml
index 1e2234257..9a0a1d34a 100644
--- a/doc/user/scanners.xml
+++ b/doc/user/scanners.xml
@@ -146,14 +146,13 @@ over the file scanning rather than being called for each input line:
<para>
- &SCons; has routines that know how to look in
+ &SCons; has built-in &Scanners; that know how to look in
C/C++, Fortran, D, IDL, LaTeX, Python and SWIG source files
for information about
other files that targets built from those files depend on -
for example, in the case of files that use the C preprocessor,
the <filename>.h</filename> files that are specified
using <literal>#include</literal> lines in the source.
- Such a routine is called a <firstterm>&Scanner;</firstterm>.
You can use the same mechanisms that &SCons; uses to create
its built-in Scanners to write Scanners of your own for file types
that &SCons; does not know how to scan "out of the box."