summaryrefslogtreecommitdiffstats
path: root/doc/user
diff options
context:
space:
mode:
authorWilliam Deegan <bill@baddogconsulting.com>2011-03-24 21:27:51 (GMT)
committerWilliam Deegan <bill@baddogconsulting.com>2011-03-24 21:27:51 (GMT)
commit1d89b2116cf0b8504fa0d77e2c19ce56b1b4a17a (patch)
treeef26ca8c3c157d57c435b1773776c07c16cf8200 /doc/user
parent9d3e484c30c20de4f7fac5cb0592cd1f33301fc1 (diff)
downloadSCons-1d89b2116cf0b8504fa0d77e2c19ce56b1b4a17a.zip
SCons-1d89b2116cf0b8504fa0d77e2c19ce56b1b4a17a.tar.gz
SCons-1d89b2116cf0b8504fa0d77e2c19ce56b1b4a17a.tar.bz2
updated docs via bin/scons-doc.py -u
Diffstat (limited to 'doc/user')
-rw-r--r--doc/user/add-method.xml1
-rw-r--r--doc/user/builders-built-in.xml1
-rw-r--r--doc/user/command-line.xml8
-rw-r--r--doc/user/depends.xml1
-rw-r--r--doc/user/less-simple.xml2
-rw-r--r--doc/user/libraries.xml3
-rw-r--r--doc/user/main.xml1
-rw-r--r--doc/user/misc.xml2
-rw-r--r--doc/user/nodes.xml2
-rw-r--r--doc/user/parseflags.xml1
-rw-r--r--doc/user/simple.xml4
-rw-r--r--doc/user/troubleshoot.xml42
-rw-r--r--doc/user/variants.xml1
13 files changed, 43 insertions, 26 deletions
diff --git a/doc/user/add-method.xml b/doc/user/add-method.xml
index d4a484e..51bc04b 100644
--- a/doc/user/add-method.xml
+++ b/doc/user/add-method.xml
@@ -113,6 +113,7 @@
rc /fores.res res.rc
cl /Fotest_stuff.obj /c test_stuff.c /nologo
link /nologo /OUT:tests\test_stuff.exe test_stuff.obj res.res
+ embedManifestExeCheck(target, source, env)
</screen>
<para>
diff --git a/doc/user/builders-built-in.xml b/doc/user/builders-built-in.xml
index b5f3808..1356022 100644
--- a/doc/user/builders-built-in.xml
+++ b/doc/user/builders-built-in.xml
@@ -160,6 +160,7 @@
cl /Fogoodbye.obj /c goodbye.c /nologo
cl /Fohello.obj /c hello.c /nologo
link /nologo /OUT:hello.exe /LIBPATH:\usr\dir1 /LIBPATH:dir2 foo1.lib foo2.lib hello.obj goodbye.obj
+ embedManifestExeCheck(target, source, env)
</screen>
<para>
diff --git a/doc/user/command-line.xml b/doc/user/command-line.xml
index 5ed8ed8..1bb84e2 100644
--- a/doc/user/command-line.xml
+++ b/doc/user/command-line.xml
@@ -1255,7 +1255,7 @@
<screen>
% <userinput>scons -Q COLOR=magenta foo.o</userinput>
- scons: *** Invalid value for option COLOR: magenta
+ scons: *** Invalid value for option COLOR: magenta. Valid values are: ('red', 'green', 'blue')
File "/home/my/project/SConstruct", line 5, in &lt;module&gt;
</screen>
@@ -1311,15 +1311,15 @@
<screen>
% <userinput>scons -Q COLOR=Red foo.o</userinput>
- scons: *** Invalid value for option COLOR: Red
+ scons: *** Invalid value for option COLOR: Red. Valid values are: ('red', 'green', 'blue')
File "/home/my/project/SConstruct", line 5, in &lt;module&gt;
% <userinput>scons -Q COLOR=BLUE foo.o</userinput>
- scons: *** Invalid value for option COLOR: BLUE
+ scons: *** Invalid value for option COLOR: BLUE. Valid values are: ('red', 'green', 'blue')
File "/home/my/project/SConstruct", line 5, in &lt;module&gt;
% <userinput>scons -Q COLOR=nAvY foo.o</userinput>
- scons: *** Invalid value for option COLOR: nAvY
+ scons: *** Invalid value for option COLOR: nAvY. Valid values are: ('red', 'green', 'blue')
File "/home/my/project/SConstruct", line 5, in &lt;module&gt;
</screen>
diff --git a/doc/user/depends.xml b/doc/user/depends.xml
index 2c728eb..2853975 100644
--- a/doc/user/depends.xml
+++ b/doc/user/depends.xml
@@ -989,6 +989,7 @@
C:\><userinput>scons -Q hello.exe</userinput>
cl /Fohello.obj /c hello.c /nologo /Iinclude /I\home\project\inc
link /nologo /OUT:hello.exe hello.obj
+ embedManifestExeCheck(target, source, env)
</screen>
</section>
diff --git a/doc/user/less-simple.xml b/doc/user/less-simple.xml
index 8b781dd..a2b5cf6 100644
--- a/doc/user/less-simple.xml
+++ b/doc/user/less-simple.xml
@@ -102,6 +102,7 @@
C:\><userinput>scons -Q</userinput>
cl /Fohello.obj /c hello.c /nologo
link /nologo /OUT:new_hello.exe hello.obj
+ embedManifestExeCheck(target, source, env)
</screen>
</section>
@@ -193,6 +194,7 @@
cl /Fofile2.obj /c file2.c /nologo
cl /Foprog.obj /c prog.c /nologo
link /nologo /OUT:program.exe prog.obj file1.obj file2.obj
+ embedManifestExeCheck(target, source, env)
</screen>
</section>
diff --git a/doc/user/libraries.xml b/doc/user/libraries.xml
index 1fa06af..9347668 100644
--- a/doc/user/libraries.xml
+++ b/doc/user/libraries.xml
@@ -206,6 +206,7 @@
cl /Fof3.obj /c f3.c /nologo
link /nologo /dll /out:foo.dll /implib:foo.lib f1.obj f2.obj f3.obj
RegServerFunc(target, source, env)
+ embedManifestDllCheck(target, source, env)
</screen>
<para>
@@ -288,6 +289,7 @@
lib /nologo /OUT:foo.lib f1.obj f2.obj f3.obj
cl /Foprog.obj /c prog.c /nologo
link /nologo /OUT:prog.exe /LIBPATH:. foo.lib bar.lib prog.obj
+ embedManifestExeCheck(target, source, env)
</screen>
<para>
@@ -412,6 +414,7 @@
C:\><userinput>scons -Q</userinput>
cl /Foprog.obj /c prog.c /nologo
link /nologo /OUT:prog.exe /LIBPATH:\usr\lib /LIBPATH:\usr\local\lib m.lib prog.obj
+ embedManifestExeCheck(target, source, env)
</screen>
<!-- The link command is too wide in the PDF version.
There are some other examples of this throughout the document. -->
diff --git a/doc/user/main.xml b/doc/user/main.xml
index 4b0807d..33d3ad2 100644
--- a/doc/user/main.xml
+++ b/doc/user/main.xml
@@ -1,4 +1,3 @@
-<?xml version="1.0"?>
<!--
__COPYRIGHT__
diff --git a/doc/user/misc.xml b/doc/user/misc.xml
index 6595eb3..a8885d7 100644
--- a/doc/user/misc.xml
+++ b/doc/user/misc.xml
@@ -253,7 +253,7 @@
<screen>
% <userinput>scons -Q</userinput>
None
- SCons.Node.FS.File exists
+ &lt;class 'SCons.Node.FS.File'&gt; exists
scons: `.' is up to date.
</screen>
diff --git a/doc/user/nodes.xml b/doc/user/nodes.xml
index e27d894..42d44c6 100644
--- a/doc/user/nodes.xml
+++ b/doc/user/nodes.xml
@@ -131,6 +131,7 @@
cl /Fogoodbye.obj /c goodbye.c -DGOODBYE
cl /Fohello.obj /c hello.c -DHELLO
link /nologo /OUT:hello.exe hello.obj goodbye.obj
+ embedManifestExeCheck(target, source, env)
</screen>
<para>
@@ -275,6 +276,7 @@
The program file is: hello.exe
cl /Fohello.obj /c hello.c /nologo
link /nologo /OUT:hello.exe hello.obj
+ embedManifestExeCheck(target, source, env)
</screen>
<para>
diff --git a/doc/user/parseflags.xml b/doc/user/parseflags.xml
index e5aadec..d3f33c3 100644
--- a/doc/user/parseflags.xml
+++ b/doc/user/parseflags.xml
@@ -91,6 +91,7 @@
LIBS ['foo']
cl /Fof1.obj /c f1.c /nologo /I\opt\include
link /nologo /OUT:f1.exe /LIBPATH:\opt\lib foo.lib f1.obj
+ embedManifestExeCheck(target, source, env)
</screen>
<para>
diff --git a/doc/user/simple.xml b/doc/user/simple.xml
index 6bd70b0..2a687a0 100644
--- a/doc/user/simple.xml
+++ b/doc/user/simple.xml
@@ -110,6 +110,7 @@
scons: Building targets ...
cl /Fohello.obj /c hello.c /nologo
link /nologo /OUT:hello.exe hello.obj
+ embedManifestExeCheck(target, source, env)
scons: done building targets.
</screen>
@@ -300,6 +301,7 @@
scons: Building targets ...
cl /Fohello.obj /c hello.c /nologo
link /nologo /OUT:hello.exe hello.obj
+ embedManifestExeCheck(target, source, env)
scons: done building targets.
C:\><userinput>scons -c</userinput>
scons: Reading SConscript files ...
@@ -507,6 +509,7 @@
scons: Building targets ...
cl /Fohello.obj /c hello.c /nologo
link /nologo /OUT:hello.exe hello.obj
+ embedManifestExeCheck(target, source, env)
scons: done building targets.
</screen>
@@ -536,6 +539,7 @@
C:\><userinput>scons -Q</userinput>
cl /Fohello.obj /c hello.c /nologo
link /nologo /OUT:hello.exe hello.obj
+ embedManifestExeCheck(target, source, env)
</screen>
<para>
diff --git a/doc/user/troubleshoot.xml b/doc/user/troubleshoot.xml
index aa6e7f8..427d515 100644
--- a/doc/user/troubleshoot.xml
+++ b/doc/user/troubleshoot.xml
@@ -282,13 +282,14 @@
'.mm',
'.S',
'.spp',
- '.SPP'],
+ '.SPP',
+ '.sx'],
'DSUFFIXES': ['.d'],
- 'Dir': &lt;SCons.Defaults.Variable_Method_Caller instance at 0x700000&gt;,
- 'Dirs': &lt;SCons.Defaults.Variable_Method_Caller instance at 0x700000&gt;,
+ 'Dir': &lt;SCons.Defaults.Variable_Method_Caller object at 0x700000&gt;,
+ 'Dirs': &lt;SCons.Defaults.Variable_Method_Caller object at 0x700000&gt;,
'ENV': { 'PATH': '/usr/local/bin:/opt/bin:/bin:/usr/bin'},
'ESCAPE': &lt;function escape at 0x700000&gt;,
- 'File': &lt;SCons.Defaults.Variable_Method_Caller instance at 0x700000&gt;,
+ 'File': &lt;SCons.Defaults.Variable_Method_Caller object at 0x700000&gt;,
'HOST_ARCH': None,
'HOST_OS': None,
'IDLSUFFIXES': ['.idl', '.IDL'],
@@ -304,7 +305,7 @@
'PROGPREFIX': '',
'PROGSUFFIX': '',
'PSPAWN': &lt;function piped_env_spawn at 0x700000&gt;,
- 'RDirs': &lt;SCons.Defaults.Variable_Method_Caller instance at 0x700000&gt;,
+ 'RDirs': &lt;SCons.Defaults.Variable_Method_Caller object at 0x700000&gt;,
'SCANNERS': [],
'SHELL': 'sh',
'SHLIBPREFIX': '$LIBPREFIX',
@@ -314,7 +315,7 @@
'SPAWN': &lt;function spawnvpe_spawn at 0x700000&gt;,
'TARGET_ARCH': None,
'TARGET_OS': None,
- 'TEMPFILE': &lt;class SCons.Platform.TempFileMunge at 0x700000&gt;,
+ 'TEMPFILE': &lt;class 'SCons.Platform.TempFileMunge'&gt;,
'TEMPFILEPREFIX': '@',
'TOOLS': ['install', 'install'],
'_CPPDEFFLAGS': '${_defines(CPPDEFPREFIX, CPPDEFINES, CPPDEFSUFFIX, __env__)}',
@@ -341,11 +342,11 @@
<screen>
C:\><userinput>scons</userinput>
scons: Reading SConscript files ...
- { 'BUILDERS': {'_InternalInstall': &lt;function InstallBuilderWrapper at 0x700000&gt;, 'Object': &lt;SCons.Builder.CompositeBuilder instance at 0x700000&gt;, 'PCH': &lt;SCons.Builder.BuilderBase instance at 0x700000&gt;, 'RES': &lt;SCons.Builder.BuilderBase instance at 0x700000&gt;, 'SharedObject': &lt;SCons.Builder.CompositeBuilder instance at 0x700000&gt;, 'StaticObject': &lt;SCons.Builder.CompositeBuilder instance at 0x700000&gt;, '_InternalInstallAs': &lt;function InstallAsBuilderWrapper at 0x700000&gt;},
+ { 'BUILDERS': {'_InternalInstall': &lt;function InstallBuilderWrapper at 0x700000&gt;, 'Object': &lt;SCons.Builder.CompositeBuilder object at 0x700000&gt;, 'PCH': &lt;SCons.Builder.BuilderBase object at 0x700000&gt;, 'RES': &lt;SCons.Builder.BuilderBase object at 0x700000&gt;, 'SharedObject': &lt;SCons.Builder.CompositeBuilder object at 0x700000&gt;, 'StaticObject': &lt;SCons.Builder.CompositeBuilder object at 0x700000&gt;, '_InternalInstallAs': &lt;function InstallAsBuilderWrapper at 0x700000&gt;},
'CC': 'cl',
- 'CCCOM': &lt;SCons.Action.FunctionAction instance at 0x700000&gt;,
+ 'CCCOM': &lt;SCons.Action.FunctionAction object at 0x700000&gt;,
'CCFLAGS': ['/nologo'],
- 'CCPCHFLAGS': ['${(PCH and "/Yu%s /Fp%s"%(PCHSTOP or "",File(PCH))) or ""}'],
+ 'CCPCHFLAGS': ['${(PCH and "/Yu%s \\"/Fp%s\\""%(PCHSTOP or "",File(PCH))) or ""}'],
'CCPDBFLAGS': ['${(PDB and "/Z7") or ""}'],
'CFILESUFFIX': '.c',
'CFLAGS': [],
@@ -371,19 +372,20 @@
'.mm',
'.S',
'.spp',
- '.SPP'],
+ '.SPP',
+ '.sx'],
'CXX': '$CC',
'CXXCOM': '$CXX $_MSVC_OUTPUT_FLAG /c $CHANGED_SOURCES $CXXFLAGS $CCFLAGS $_CCCOMCOM',
'CXXFILESUFFIX': '.cc',
'CXXFLAGS': ['$(', '/TP', '$)'],
'DSUFFIXES': ['.d'],
- 'Dir': &lt;SCons.Defaults.Variable_Method_Caller instance at 0x700000&gt;,
- 'Dirs': &lt;SCons.Defaults.Variable_Method_Caller instance at 0x700000&gt;,
+ 'Dir': &lt;SCons.Defaults.Variable_Method_Caller object at 0x700000&gt;,
+ 'Dirs': &lt;SCons.Defaults.Variable_Method_Caller object at 0x700000&gt;,
'ENV': { 'PATH': 'C:\\WINDOWS\\System32',
'PATHEXT': '.COM;.EXE;.BAT;.CMD',
'SystemRoot': 'C:\\WINDOWS'},
'ESCAPE': &lt;function escape at 0x700000&gt;,
- 'File': &lt;SCons.Defaults.Variable_Method_Caller instance at 0x700000&gt;,
+ 'File': &lt;SCons.Defaults.Variable_Method_Caller object at 0x700000&gt;,
'HOST_ARCH': '',
'HOST_OS': 'win32',
'IDLSUFFIXES': ['.idl', '.IDL'],
@@ -405,13 +407,13 @@
'PROGSUFFIX': '.exe',
'PSPAWN': &lt;function piped_spawn at 0x700000&gt;,
'RC': 'rc',
- 'RCCOM': &lt;SCons.Action.FunctionAction instance at 0x700000&gt;,
+ 'RCCOM': &lt;SCons.Action.FunctionAction object at 0x700000&gt;,
'RCFLAGS': [],
'RCSUFFIXES': ['.rc', '.rc2'],
- 'RDirs': &lt;SCons.Defaults.Variable_Method_Caller instance at 0x700000&gt;,
+ 'RDirs': &lt;SCons.Defaults.Variable_Method_Caller object at 0x700000&gt;,
'SCANNERS': [],
'SHCC': '$CC',
- 'SHCCCOM': &lt;SCons.Action.FunctionAction instance at 0x700000&gt;,
+ 'SHCCCOM': &lt;SCons.Action.FunctionAction object at 0x700000&gt;,
'SHCCFLAGS': ['$CCFLAGS'],
'SHCFLAGS': ['$CFLAGS'],
'SHCXX': '$CXX',
@@ -426,7 +428,7 @@
'STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME': 1,
'TARGET_ARCH': '',
'TARGET_OS': 'win32',
- 'TEMPFILE': &lt;class SCons.Platform.TempFileMunge at 0x700000&gt;,
+ 'TEMPFILE': &lt;class 'SCons.Platform.TempFileMunge'&gt;,
'TEMPFILEPREFIX': '@',
'TOOLS': ['msvc', 'install', 'install'],
'_CCCOMCOM': '$CPPFLAGS $_CPPDEFFLAGS $_CPPINCFLAGS $CCPCHFLAGS $CCPDBFLAGS',
@@ -1120,9 +1122,9 @@
scons: internal stack trace:
File "bootstrap/src/engine/SCons/Job.py", line 199, in start
task.prepare()
- File "bootstrap/src/engine/SCons/Script/Main.py", line 167, in prepare
+ File "bootstrap/src/engine/SCons/Script/Main.py", line 168, in prepare
return SCons.Taskmaster.OutOfDateTask.prepare(self)
- File "bootstrap/src/engine/SCons/Taskmaster.py", line 187, in prepare
+ File "bootstrap/src/engine/SCons/Taskmaster.py", line 189, in prepare
executor.prepare()
File "bootstrap/src/engine/SCons/Executor.py", line 392, in prepare
raise SCons.Errors.StopError(msg % (s, self.batches[0].targets[0]))
@@ -1272,7 +1274,6 @@
to see all the targets &SCons; is considering, whether
they are already up-to-date or not. The message is
printed before &SCons; decides whether to build the target.
-
</para>
</section>
@@ -1301,6 +1302,7 @@
<!--
+
<section>
<title>Where Are My Build Bottlenecks? the &profile; Option</title>
diff --git a/doc/user/variants.xml b/doc/user/variants.xml
index 3ae3e4a..29d2d65 100644
--- a/doc/user/variants.xml
+++ b/doc/user/variants.xml
@@ -114,6 +114,7 @@ is pretty smart about rebuilding things when you change options.
lib /nologo /OUT:build\windows\world\world.lib build\windows\world\world.obj
Install file: "build/windows/world/world.lib" as "export/windows/lib/world.lib"
link /nologo /OUT:build\windows\hello\hello.exe /LIBPATH:export\windows\lib world.lib build\windows\hello\hello.obj
+ embedManifestExeCheck(target, source, env)
Install file: "build/windows/hello/hello.exe" as "export/windows/bin/hello.exe"
</screen>