Commits

William Deegan committed 2ff53cc

updated docs via bin/scons-doc.py -u

  • Participants
  • Parent commits ab68111

Comments (0)

Files changed (13)

doc/user/add-method.xml

     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>

doc/user/builders-built-in.xml

       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>

doc/user/command-line.xml

         <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>
 
         <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>
 

doc/user/depends.xml

        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>

doc/user/less-simple.xml

        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>
        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>

doc/user/libraries.xml

         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>
       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>
       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. -->

doc/user/main.xml

-<?xml version="1.0"?>
 <!--
 
   __COPYRIGHT__

doc/user/misc.xml

     <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>
 

doc/user/nodes.xml

        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>
       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>

doc/user/parseflags.xml

     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>

doc/user/simple.xml

       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>
 
       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 ...
       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>
 
       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>

doc/user/troubleshoot.xml

                          '.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'],
         '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',
         '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__)}',
     <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': [],
                          '.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'],
         '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',
         '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',
       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]))
     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>
 
   <!--
 
+
   <section>
 
   <title>Where Are My Build Bottlenecks?  the &profile; Option</title>

doc/user/variants.xml

     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>