summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorWilliam Deegan <bill@baddogconsulting.com>2019-02-02 18:30:42 (GMT)
committerGitHub <noreply@github.com>2019-02-02 18:30:42 (GMT)
commit5e859ac7a1aee773e23679ffdeaabdd4a957cf4c (patch)
tree26c167283c196142b395f55172a1bc6ce72bf563 /doc
parent2b1d78af4586878d8fabb99cd9037c5d105a4e29 (diff)
parent3c785d3842e5cfd41689782d1e6425e0f6fd0f7f (diff)
downloadSCons-5e859ac7a1aee773e23679ffdeaabdd4a957cf4c.zip
SCons-5e859ac7a1aee773e23679ffdeaabdd4a957cf4c.tar.gz
SCons-5e859ac7a1aee773e23679ffdeaabdd4a957cf4c.tar.bz2
Merge pull request #3261 from mwichmann/doc-default
Improve scons docs regarding Default()
Diffstat (limited to 'doc')
-rw-r--r--doc/man/scons.xml2
-rw-r--r--doc/user/command-line.xml18
2 files changed, 11 insertions, 9 deletions
diff --git a/doc/man/scons.xml b/doc/man/scons.xml
index 0f59967..dc6c36c 100644
--- a/doc/man/scons.xml
+++ b/doc/man/scons.xml
@@ -274,7 +274,7 @@ scons
<para>will build all target files in or below the current directory.
Explicit default targets
(to be built when no targets are specified on the command line)
-may be defined the SConscript file(s)
+may be defined in the SConscript file(s)
using the
<emphasis role="bold">Default()</emphasis>
function, described below.</para>
diff --git a/doc/user/command-line.xml b/doc/user/command-line.xml
index 1b329e7..d129d2e 100644
--- a/doc/user/command-line.xml
+++ b/doc/user/command-line.xml
@@ -1987,17 +1987,16 @@ foo.c
<para>
- One of the most basic things you can control
- is which targets &SCons; will build by default--that is,
+ You can control
+ which targets &SCons; will build by default - that is,
when there are no targets specified on the command line.
As mentioned previously,
&SCons; will normally build every target
- in or below the current directory
- by default--that is, when you don't
+ in or below the current directory unless you
explicitly specify one or more targets
on the command line.
Sometimes, however, you may want
- to specify explicitly that only
+ to specify that only
certain programs, or programs in certain directories,
should be built by default.
You do this with the &Default; function:
@@ -2193,7 +2192,8 @@ prog2.c
<para>
&SCons; supports a &DEFAULT_TARGETS; variable
- that lets you get at the current list of default targets.
+ that lets you get at the current list of default targets
+ specified by calls to the &Default; function or method.
The &DEFAULT_TARGETS; variable has
two important differences from the &COMMAND_LINE_TARGETS; variable.
First, the &DEFAULT_TARGETS; variable is a list of
@@ -2233,7 +2233,7 @@ prog1.c
<para>
Second,
- the contents of the &DEFAULT_TARGETS; list change
+ the contents of the &DEFAULT_TARGETS; list changes
in response to calls to the &Default; function,
as you can see from the following &SConstruct; file:
@@ -2351,7 +2351,9 @@ prog2.c
Notice how the value of &BUILD_TARGETS;
changes depending on whether a target is
- specified on the command line:
+ specified on the command line - &BUILD_TARGETS;
+ takes from &DEFAULT_TARGETS;
+ only if there are no &COMMAND_LINE_TARGETS;:
</para>