summaryrefslogtreecommitdiffstats
path: root/doc/user/environments.in
diff options
context:
space:
mode:
authorSteven Knight <knight@baldmt.com>2005-02-15 13:55:44 (GMT)
committerSteven Knight <knight@baldmt.com>2005-02-15 13:55:44 (GMT)
commitd809676c50c89f74f3210d4faf61c3f66a600777 (patch)
tree18a308eb5aa145b95de56c05aca90a609c3eaaf6 /doc/user/environments.in
parentf995934a8dca09977039d3a9bdb263805c1282b6 (diff)
downloadSCons-d809676c50c89f74f3210d4faf61c3f66a600777.zip
SCons-d809676c50c89f74f3210d4faf61c3f66a600777.tar.gz
SCons-d809676c50c89f74f3210d4faf61c3f66a600777.tar.bz2
Accumulated documentation changes.
Diffstat (limited to 'doc/user/environments.in')
-rw-r--r--doc/user/environments.in65
1 files changed, 33 insertions, 32 deletions
diff --git a/doc/user/environments.in b/doc/user/environments.in
index 47a3c44..586242c 100644
--- a/doc/user/environments.in
+++ b/doc/user/environments.in
@@ -468,7 +468,8 @@ environment undisturbed.
and further specifies that the <literal>-O2</literal>
(optimization level two)
flag should be used when compiling the object file.
- In other words, the explicit initializations of &CC; and &CCFLAGS;
+ In other words, the explicit initializations of
+ &cv-link-CC; and &cv-link-CCFLAGS;
override the default values in the newly-created
construction environment.
So a run from this example would look like:
@@ -476,7 +477,7 @@ environment undisturbed.
</para>
<scons_output example="ex1">
- <command>scons -Q</command>
+ <scons_output_command>scons -Q</scons_output_command>
</scons_output>
<section>
@@ -514,7 +515,7 @@ environment undisturbed.
</scons_example>
<scons_output example="ex2">
- <command>scons -Q</command>
+ <scons_output_command>scons -Q</scons_output_command>
</scons_output>
<para>
@@ -522,7 +523,7 @@ environment undisturbed.
We can even use multiple construction environments to build
multiple versions of a single program.
If you do this by simply trying to use the
- &Program; builder with both environments, though,
+ &b-link-Program; builder with both environments, though,
like this:
</para>
@@ -548,17 +549,17 @@ environment undisturbed.
</para>
<scons_output example="ex3">
- <command>scons -Q</command>
+ <scons_output_command>scons -Q</scons_output_command>
</scons_output>
<para>
- This is because the two &Program; calls have
+ This is because the two &b-Program; calls have
each implicitly told &SCons; to generate an object file named
<filename>foo.o</filename>,
- one with a &CCFLAGS; value of
+ one with a &cv-link-CCFLAGS; value of
<literal>-O2</literal>
- and one with a &CCFLAGS; value of
+ and one with a &cv-link-CCFLAGS; value of
<literal>-g</literal>.
&SCons; can't just decide that one of them
should take precedence over the other,
@@ -568,7 +569,7 @@ environment undisturbed.
that each environment compile
<filename>foo.c</filename>
to a separately-named object file
- using the &Object; call, like so:
+ using the &b-link-Object; builder, like so:
</para>
@@ -590,12 +591,12 @@ environment undisturbed.
<para>
- Notice that each call to the &Object; builder
+ Notice that each call to the &b-Object; builder
returns a value,
an internal &SCons; object that
represents the object file that will be built.
We then use that object
- as input to the &Program; builder.
+ as input to the &b-Program; builder.
This avoids having to specify explicitly
the object file name in multiple places,
and makes for a compact, readable
@@ -605,7 +606,7 @@ environment undisturbed.
</para>
<scons_output example="ex4">
- <command>scons -Q</command>
+ <scons_output_command>scons -Q</scons_output_command>
</scons_output>
</section>
@@ -633,10 +634,10 @@ environment undisturbed.
to create three versions of a program,
one optimized, one debug, and one with neither.
We could do this by creating a "base" construction environment
- that sets &CC; to &gcc;,
+ that sets &cv-link-CC; to &gcc;,
and then creating two copies,
- one which sets &CCFLAGS; for optimization
- and the other which sets &CCFLAGS; for debugging:
+ one which sets &cv-link-CCFLAGS; for optimization
+ and the other which sets &cv-CCFLAGS; for debugging:
</para>
@@ -666,7 +667,7 @@ environment undisturbed.
</para>
<scons_output example="ex5">
- <command>scons -Q</command>
+ <scons_output_command>scons -Q</scons_output_command>
</scons_output>
</section>
@@ -693,12 +694,12 @@ environment undisturbed.
This example &SConstruct; file doesn't build anything,
but because it's actually a Python script,
- it will print the value of &CC; for us:
+ it will print the value of &cv-link-CC; for us:
</para>
<scons_output example="ex6">
- <command>scons -Q</command>
+ <scons_output_command>scons -Q</scons_output_command>
</scons_output>
<para>
@@ -729,7 +730,7 @@ environment undisturbed.
</para>
<scons_output example="ex6b" os="posix">
- <command>scons -Q</command>
+ <scons_output_command>scons -Q</scons_output_command>
</scons_output>
<para>
@@ -739,7 +740,7 @@ environment undisturbed.
</para>
<scons_output example="ex6b" os="win32">
- <command>scons -Q</command>
+ <scons_output_command>scons -Q</scons_output_command>
</scons_output>
<para>
@@ -775,7 +776,7 @@ environment undisturbed.
the example from the previous
section that used
<literal>env['CC']</literal>
- to fetch the value of &CC;
+ to fetch the value of &cv-link-CC;
could also be written as:
</para>
@@ -794,7 +795,7 @@ environment undisturbed.
re-expanded until
there are no expansions left in the string.
So a simple fetch of a value like
- <varname>$CCCOM</varname>:
+ &cv-link-CCCOM;:
</para>
@@ -805,7 +806,7 @@ environment undisturbed.
<para>
- Will print the unexpanded value of &CCCOM;,
+ Will print the unexpanded value of &cv-CCCOM;,
showing us the construction
variables that still need to be expanded:
@@ -848,7 +849,7 @@ environment undisturbed.
(Note that because we're not expanding this
in the context of building something
there are no target or source files
- for <varname>$TARGET</varname> and <varname>$SOURCES</varname> to expand.
+ for &cv-link-TARGET; and &cv-link-SOURCES; to expand.
</para>
@@ -895,7 +896,7 @@ environment undisturbed.
</para>
<scons_output example="Replace1">
- <command>scons -Q</command>
+ <scons_output_command>scons -Q</scons_output_command>
</scons_output>
<para>
@@ -923,7 +924,7 @@ environment undisturbed.
</para>
<scons_output example="Replace-nonexistent">
- <command>scons -Q</command>
+ <scons_output_command>scons -Q</scons_output_command>
</scons_output>
<para>
@@ -972,14 +973,14 @@ environment undisturbed.
</para>
<scons_output example="Replace2">
- <command>scons</command>
+ <scons_output_command>scons</scons_output_command>
</scons_output>
<para>
Because the replacement occurs while
the &SConscript; files are being read,
- the <literal>$CCFLAGS</literal>
+ the &cv-link-CCFLAGS;
variable has already been set to
<literal>-DDEFINE2</literal>
by the time the &foo_o; target is built,
@@ -1021,7 +1022,7 @@ environment undisturbed.
</para>
<scons_output example="ex8">
- <command>scons -Q</command>
+ <scons_output_command>scons -Q</scons_output_command>
</scons_output>
<para>
@@ -1046,7 +1047,7 @@ environment undisturbed.
</para>
<scons_output example="Append-nonexistent">
- <command>scons -Q</command>
+ <scons_output_command>scons -Q</scons_output_command>
</scons_output>
</section>
@@ -1081,7 +1082,7 @@ environment undisturbed.
</para>
<scons_output example="ex9">
- <command>scons -Q</command>
+ <scons_output_command>scons -Q</scons_output_command>
</scons_output>
<para>
@@ -1106,7 +1107,7 @@ environment undisturbed.
</para>
<scons_output example="Prepend-nonexistent">
- <command>scons -Q</command>
+ <scons_output_command>scons -Q</scons_output_command>
</scons_output>
</section>