Fix a User's Guide example. (Sanjoy Mahajan)

4 files changed, 15 insertions, 5 deletions

diff --git a/doc/SConscript b/doc/SConscript
index 008f205..a51dd79 100644
--- a/doc/SConscript
+++ b/doc/SConscript
@@ -158,13 +158,21 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE.  DO NOT EDIT.
     variables_gen = os.path.join(build, 'user', 'variables.gen')
     variables_mod = os.path.join(build, 'user', 'variables.mod')
 
+    # We put $( - $) around $SOURCES in the command line below because
+    # the path names will change when a given input file is found in
+    # a repository one run and locally the next, and we don't want
+    # to rebuild documentation just because it's found in one location
+    # vs. the other.  The *.gen and *.mod targets will still be dependent
+    # on the list of the files themselves.
     b = env.Command([builders_gen, builders_mod,
                      tools_gen, tools_mod,
                      variables_gen, variables_mod],
                     scons_doc_files,
-                    "python $SCONS_PROC_PY -b ${TARGETS[0]},${TARGETS[1]} -t ${TARGETS[2]},${TARGETS[3]} -v ${TARGETS[4]},${TARGETS[5]} $SOURCES")
+                    "python $SCONS_PROC_PY -b ${TARGETS[0]},${TARGETS[1]} -t ${TARGETS[2]},${TARGETS[3]} -v ${TARGETS[4]},${TARGETS[5]} $( $SOURCES $)")
     env.Depends(b, "$SCONS_PROC_PY")
 
+    env.Local(b)
+
     #
     # Each document will live in its own subdirectory.  List them here
     # as hash keys, with a hash of the info to control its build.
diff --git a/doc/man/scons.1 b/doc/man/scons.1
index 986c14b..c627a19 100644
--- a/doc/man/scons.1
+++ b/doc/man/scons.1
@@ -9737,6 +9737,8 @@ env['BUILDERS]['PDFBuilder'] = bld
 .ES
 import re
 
+'\" Note:  the \\ in the following are for the benefit of nroff/troff,
+'\" not inappropriate doubled escape characters within the r'' raw string.
 include_re = re.compile(r'^include\\s+(\\S+)$', re.M)
 
 def kfile_scan(node, env, path, arg):
diff --git a/doc/user/scanners.in b/doc/user/scanners.in
index a0029ef..63c0722 100644
--- a/doc/user/scanners.in
+++ b/doc/user/scanners.in
@@ -167,7 +167,7 @@ over the file scanning rather than being called for each input line:
     <programlisting>
       import re
       
-      include_re = re.compile(r'^include\\s+(\\S+)$', re.M)
+      include_re = re.compile(r'^include\s+(\S+)$', re.M)
       
       def kfile_scan(node, env, path, arg):
           contents = node.get_contents()
@@ -278,7 +278,7 @@ over the file scanning rather than being called for each input line:
       <file name="SConstruct" printme="1">
         import re
 
-        include_re = re.compile(r'^include\\s+(\\S+)$', re.M)
+        include_re = re.compile(r'^include\s+(\S+)$', re.M)
 
         def kfile_scan(node, env, path):
             contents = node.get_contents()
diff --git a/doc/user/scanners.sgml b/doc/user/scanners.sgml
index b4756c5..c068d03 100644
--- a/doc/user/scanners.sgml
+++ b/doc/user/scanners.sgml
@@ -167,7 +167,7 @@ over the file scanning rather than being called for each input line:
     <programlisting>
       import re
       
-      include_re = re.compile(r'^include\\s+(\\S+)$', re.M)
+      include_re = re.compile(r'^include\s+(\S+)$', re.M)
       
       def kfile_scan(node, env, path, arg):
           contents = node.get_contents()
@@ -277,7 +277,7 @@ over the file scanning rather than being called for each input line:
     <programlisting>
         import re
 
-        include_re = re.compile(r'^include\\s+(\\S+)$', re.M)
+        include_re = re.compile(r'^include\s+(\S+)$', re.M)
 
         def kfile_scan(node, env, path):
             contents = node.get_contents()