Merged in williamblevins/scons (pull request #164), update of documentation for issue #2395

15 files changed, 158 insertions, 15 deletions

diff --git a/.hgignore b/.hgignore
index 053e916e..27c728a1 100644
--- a/.hgignore
+++ b/.hgignore
@@ -9,3 +9,10 @@ syntax:glob
 *~
 *.xcodeproj
 *.orig
+
+doc/user/scons-user
+doc/user/scons_db.xml
+doc/user/scons_ex.xml
+doc/user/scons_exi.xml
+doc/user/scons_xi.xml
+doc/user/index.html
diff --git a/doc/generated/tools.gen b/doc/generated/tools.gen
index a4c4a3bc..dc9b50da 100644
--- a/doc/generated/tools.gen
+++ b/doc/generated/tools.gen
@@ -144,7 +144,7 @@ for the platform on which SCons is running.
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
 Sets construction variables for D language compiler DMD.
 </para>
-<para>Sets:  &cv-link-DC;, &cv-link-DCOM;, &cv-link-DDEBUG;, &cv-link-DDEBUGPREFIX;, &cv-link-DDEBUGSUFFIX;, &cv-link-DFILESUFFIX;, &cv-link-DFLAGPREFIX;, &cv-link-DFLAGS;, &cv-link-DFLAGSUFFIX;, &cv-link-DINCPREFIX;, &cv-link-DINCSUFFIX;, &cv-link-DLIB;, &cv-link-DLIBCOM;, &cv-link-DLIBDIRPREFIX;, &cv-link-DLIBDIRSUFFIX;, &cv-link-DLIBFLAGPREFIX;, &cv-link-DLIBFLAGSUFFIX;, &cv-link-DLIBLINKPREFIX;, &cv-link-DLIBLINKSUFFIX;, &cv-link-DLINK;, &cv-link-DLINKCOM;, &cv-link-DLINKFLAGS;, &cv-link-DPATH;, &cv-link-DVERPREFIX;, &cv-link-DVERSIONS;, &cv-link-DVERSUFFIX;, &cv-link-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHDC;, &cv-link-SHDCOM;, &cv-link-SHDLINK;, &cv-link-SHDLINKCOM;, &cv-link-SHDLINKFLAGS;, &cv-link-STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME;, &cv-link-_DDEBUGFLAGS;, &cv-link-_DFLAGS;, &cv-link-_DINCFLAGS;, &cv-link-_DLIBDIRFLAGS;, &cv-link-_DLIBFLAGS;, &cv-link-_DLIBFLAGS;, &cv-link-_DVERFLAGS;, &cv-link-_RPATH;.</para></listitem>
+<para>Sets:  &cv-link-DC;, &cv-link-DCOM;, &cv-link-DDEBUG;, &cv-link-DDEBUGPREFIX;, &cv-link-DDEBUGSUFFIX;, &cv-link-DFILESUFFIX;, &cv-link-DFLAGPREFIX;, &cv-link-DFLAGS;, &cv-link-DFLAGSUFFIX;, &cv-link-DINCPREFIX;, &cv-link-DINCSUFFIX;, &cv-link-DLIB;, &cv-link-DLIBCOM;, &cv-link-DLIBDIRPREFIX;, &cv-link-DLIBDIRSUFFIX;, &cv-link-DLIBFLAGPREFIX;, &cv-link-DLIBFLAGSUFFIX;, &cv-link-DLIBLINKPREFIX;, &cv-link-DLIBLINKSUFFIX;, &cv-link-DLINK;, &cv-link-DLINKCOM;, &cv-link-DLINKFLAGS;, &cv-link-DPATH;, &cv-link-DVERPREFIX;, &cv-link-DVERSIONS;, &cv-link-DVERSUFFIX;, &cv-link-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHDC;, &cv-link-SHDCOM;, &cv-link-SHDLINK;, &cv-link-SHDLINKCOM;, &cv-link-SHDLINKFLAGS;, &cv-link-_DDEBUGFLAGS;, &cv-link-_DFLAGS;, &cv-link-_DINCFLAGS;, &cv-link-_DLIBDIRFLAGS;, &cv-link-_DLIBFLAGS;, &cv-link-_DLIBFLAGS;, &cv-link-_DVERFLAGS;, &cv-link-_RPATH;.</para></listitem>
   </varlistentry>
   <varlistentry id="t-docbook">
     <term>docbook</term>
@@ -380,7 +380,7 @@ Set construction variables for the <application xmlns="http://www.scons.org/dbxs
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
 Sets construction variables for the D language compiler GDC.
 </para>
-<para>Sets:  &cv-link-DC;, &cv-link-DCOM;, &cv-link-DDEBUG;, &cv-link-DDEBUGPREFIX;, &cv-link-DDEBUGSUFFIX;, &cv-link-DFILESUFFIX;, &cv-link-DFLAGPREFIX;, &cv-link-DFLAGS;, &cv-link-DFLAGSUFFIX;, &cv-link-DINCPREFIX;, &cv-link-DINCSUFFIX;, &cv-link-DLIB;, &cv-link-DLIBCOM;, &cv-link-DLIBFLAGPREFIX;, &cv-link-DLIBFLAGSUFFIX;, &cv-link-DLINK;, &cv-link-DLINKCOM;, &cv-link-DLINKFLAGPREFIX;, &cv-link-DLINKFLAGS;, &cv-link-DLINKFLAGSUFFIX;, &cv-link-DPATH;, &cv-link-DVERPREFIX;, &cv-link-DVERSIONS;, &cv-link-DVERSUFFIX;, &cv-link-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHDC;, &cv-link-SHDCOM;, &cv-link-SHDLINK;, &cv-link-SHDLINKCOM;, &cv-link-SHDLINKFLAGS;, &cv-link-STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME;, &cv-link-_DDEBUGFLAGS;, &cv-link-_DFLAGS;, &cv-link-_DINCFLAGS;, &cv-link-_DLIBFLAGS;, &cv-link-_DVERFLAGS;, &cv-link-_RPATH;.</para></listitem>
+<para>Sets:  &cv-link-DC;, &cv-link-DCOM;, &cv-link-DDEBUG;, &cv-link-DDEBUGPREFIX;, &cv-link-DDEBUGSUFFIX;, &cv-link-DFILESUFFIX;, &cv-link-DFLAGPREFIX;, &cv-link-DFLAGS;, &cv-link-DFLAGSUFFIX;, &cv-link-DINCPREFIX;, &cv-link-DINCSUFFIX;, &cv-link-DLIB;, &cv-link-DLIBCOM;, &cv-link-DLIBFLAGPREFIX;, &cv-link-DLIBFLAGSUFFIX;, &cv-link-DLINK;, &cv-link-DLINKCOM;, &cv-link-DLINKFLAGPREFIX;, &cv-link-DLINKFLAGS;, &cv-link-DLINKFLAGSUFFIX;, &cv-link-DPATH;, &cv-link-DVERPREFIX;, &cv-link-DVERSIONS;, &cv-link-DVERSUFFIX;, &cv-link-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHDC;, &cv-link-SHDCOM;, &cv-link-SHDLINK;, &cv-link-SHDLINKCOM;, &cv-link-SHDLINKFLAGS;, &cv-link-_DDEBUGFLAGS;, &cv-link-_DFLAGS;, &cv-link-_DINCFLAGS;, &cv-link-_DLIBFLAGS;, &cv-link-_DVERFLAGS;, &cv-link-_RPATH;.</para></listitem>
   </varlistentry>
   <varlistentry id="t-gettext">
     <term>gettext</term>
@@ -599,7 +599,7 @@ Sets construction variables for the <application xmlns="http://www.scons.org/dbx
 <para xmlns="http://www.scons.org/dbxsd/v1.0">
 Sets construction variables for the D language compiler LDC2.
 </para>
-<para>Sets:  &cv-link-DC;, &cv-link-DCOM;, &cv-link-DDEBUG;, &cv-link-DDEBUGPREFIX;, &cv-link-DDEBUGSUFFIX;, &cv-link-DFILESUFFIX;, &cv-link-DFLAGPREFIX;, &cv-link-DFLAGS;, &cv-link-DFLAGSUFFIX;, &cv-link-DINCPREFIX;, &cv-link-DINCSUFFIX;, &cv-link-DLIB;, &cv-link-DLIBCOM;, &cv-link-DLIBDIRPREFIX;, &cv-link-DLIBDIRSUFFIX;, &cv-link-DLIBFLAGPREFIX;, &cv-link-DLIBFLAGSUFFIX;, &cv-link-DLIBLINKPREFIX;, &cv-link-DLIBLINKSUFFIX;, &cv-link-DLINK;, &cv-link-DLINKCOM;, &cv-link-DLINKFLAGPREFIX;, &cv-link-DLINKFLAGS;, &cv-link-DLINKFLAGSUFFIX;, &cv-link-DPATH;, &cv-link-DVERPREFIX;, &cv-link-DVERSIONS;, &cv-link-DVERSUFFIX;, &cv-link-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHDC;, &cv-link-SHDCOM;, &cv-link-SHDLINK;, &cv-link-SHDLINKCOM;, &cv-link-SHDLINKFLAGS;, &cv-link-STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME;, &cv-link-_DDEBUGFLAGS;, &cv-link-_DFLAGS;, &cv-link-_DINCFLAGS;, &cv-link-_DLIBDIRFLAGS;, &cv-link-_DLIBFLAGS;, &cv-link-_DLIBFLAGS;, &cv-link-_DVERFLAGS;, &cv-link-_RPATH;.</para></listitem>
+<para>Sets:  &cv-link-DC;, &cv-link-DCOM;, &cv-link-DDEBUG;, &cv-link-DDEBUGPREFIX;, &cv-link-DDEBUGSUFFIX;, &cv-link-DFILESUFFIX;, &cv-link-DFLAGPREFIX;, &cv-link-DFLAGS;, &cv-link-DFLAGSUFFIX;, &cv-link-DINCPREFIX;, &cv-link-DINCSUFFIX;, &cv-link-DLIB;, &cv-link-DLIBCOM;, &cv-link-DLIBDIRPREFIX;, &cv-link-DLIBDIRSUFFIX;, &cv-link-DLIBFLAGPREFIX;, &cv-link-DLIBFLAGSUFFIX;, &cv-link-DLIBLINKPREFIX;, &cv-link-DLIBLINKSUFFIX;, &cv-link-DLINK;, &cv-link-DLINKCOM;, &cv-link-DLINKFLAGPREFIX;, &cv-link-DLINKFLAGS;, &cv-link-DLINKFLAGSUFFIX;, &cv-link-DPATH;, &cv-link-DVERPREFIX;, &cv-link-DVERSIONS;, &cv-link-DVERSUFFIX;, &cv-link-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHDC;, &cv-link-SHDCOM;, &cv-link-SHDLINK;, &cv-link-SHDLINKCOM;, &cv-link-SHDLINKFLAGS;, &cv-link-_DDEBUGFLAGS;, &cv-link-_DFLAGS;, &cv-link-_DINCFLAGS;, &cv-link-_DLIBDIRFLAGS;, &cv-link-_DLIBFLAGS;, &cv-link-_DLIBFLAGS;, &cv-link-_DVERFLAGS;, &cv-link-_RPATH;.</para></listitem>
   </varlistentry>
   <varlistentry id="t-lex">
     <term>lex</term>
diff --git a/src/CHANGES.txt b/src/CHANGES.txt
index c8c1fbf7..05e326ec 100644
--- a/src/CHANGES.txt
+++ b/src/CHANGES.txt
@@ -6,6 +6,9 @@
 
 RELEASE 2.3.2.alpha.yyyymmdd - NEW DATE WILL BE INSERTED HERE
 
+  From Kendrick Boyd and Rob Managan:
+    - Fixed the newglossary action to work with VariantDir (LaTeX).
+
   From Manuel Francisco Naranjo:
     - Added a default for the BUILDERS environment variable,
       to prevent not defined exception on a Clone().
@@ -18,6 +21,7 @@ RELEASE 2.3.2.alpha.yyyymmdd - NEW DATE WILL BE INSERTED HERE
   From William Blevins:
     - Added test for Java derived-source dependency tree generation.
     - Added Copy Action symlink soft-copy support (#2395).
+    - Various contributions to the documentation (UserGuide).
 
 RELEASE 2.3.2
 
diff --git a/src/engine/SCons/Tool/dmd.py b/src/engine/SCons/Tool/dmd.py
index 5989d777..082d5c3a 100644
--- a/src/engine/SCons/Tool/dmd.py
+++ b/src/engine/SCons/Tool/dmd.py
@@ -95,8 +95,6 @@ def generate(env):
     env['DVERSIONS'] = []
     env['DDEBUG'] = []
 
-    env['STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME'] = 0
-
     if env['DC']:
         SCons.Tool.DCommon.addDPATHToEnv(env, env['DC'])
 
diff --git a/src/engine/SCons/Tool/dmd.xml b/src/engine/SCons/Tool/dmd.xml
index 65ef75c4..f8936c12 100644
--- a/src/engine/SCons/Tool/dmd.xml
+++ b/src/engine/SCons/Tool/dmd.xml
@@ -42,7 +42,6 @@ Sets construction variables for D language compiler DMD.
 <item>DFLAGS</item>
 <item>DVERSIONS</item>
 <item>DDEBUG</item>
-<item>STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME</item>
 <item>DINCPREFIX</item>
 <item>DINCSUFFIX</item>
 <item>DVERPREFIX</item>
diff --git a/src/engine/SCons/Tool/gdc.py b/src/engine/SCons/Tool/gdc.py
index 239278b6..1178b855 100644
--- a/src/engine/SCons/Tool/gdc.py
+++ b/src/engine/SCons/Tool/gdc.py
@@ -78,8 +78,6 @@ def generate(env):
     env['DVERSIONS'] = []
     env['DDEBUG'] = []
 
-    env['STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME'] = 0
-
     if env['DC']:
         SCons.Tool.DCommon.addDPATHToEnv(env, env['DC'])
 
diff --git a/src/engine/SCons/Tool/gdc.xml b/src/engine/SCons/Tool/gdc.xml
index 99b06037..20544b00 100644
--- a/src/engine/SCons/Tool/gdc.xml
+++ b/src/engine/SCons/Tool/gdc.xml
@@ -42,7 +42,6 @@ Sets construction variables for the D language compiler GDC.
 <item>DFLAGS</item>
 <item>DVERSIONS</item>
 <item>DDEBUG</item>
-<item>STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME</item>
 <item>DINCPREFIX</item>
 <item>DINCSUFFIX</item>
 <item>DVERPREFIX</item>
diff --git a/src/engine/SCons/Tool/ldc.py b/src/engine/SCons/Tool/ldc.py
index c8555868..6b215e2f 100644
--- a/src/engine/SCons/Tool/ldc.py
+++ b/src/engine/SCons/Tool/ldc.py
@@ -83,8 +83,6 @@ def generate(env):
     env['DVERSIONS'] = []
     env['DDEBUG'] = []
 
-    env['STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME'] = 0
-
     if env['DC']:
         SCons.Tool.DCommon.addDPATHToEnv(env, env['DC'])
 
diff --git a/src/engine/SCons/Tool/ldc.xml b/src/engine/SCons/Tool/ldc.xml
index 18f676dc..f07144bd 100644
--- a/src/engine/SCons/Tool/ldc.xml
+++ b/src/engine/SCons/Tool/ldc.xml
@@ -42,7 +42,6 @@ Sets construction variables for the D language compiler LDC2.
 <item>DFLAGS</item>
 <item>DVERSIONS</item>
 <item>DDEBUG</item>
-<item>STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME</item>
 <item>DINCPREFIX</item>
 <item>DINCSUFFIX</item>
 <item>DVERPREFIX</item>
diff --git a/src/engine/SCons/Tool/tex.py b/src/engine/SCons/Tool/tex.py
index 4c10731e..053d85d4 100644
--- a/src/engine/SCons/Tool/tex.py
+++ b/src/engine/SCons/Tool/tex.py
@@ -431,7 +431,7 @@ def InternalLaTeXAuxAction(XXXLaTeXAction, target = None, source= None, env=None
                 if Verbose:
                     print "Need to run makeindex for newglossary"
                 newglfile = suffix_nodes[newglossary_suffix[ig][2]]
-                MakeNewGlossaryAction = SCons.Action.Action("$MAKENEWGLOSSARY ${SOURCE.filebase}%s -s ${SOURCE.filebase}.ist -t ${SOURCE.filebase}%s -o ${SOURCE.filebase}%s" % (newglossary_suffix[ig][2],newglossary_suffix[ig][0],newglossary_suffix[ig][1]), "$MAKENEWGLOSSARYCOMSTR")
+                MakeNewGlossaryAction = SCons.Action.Action("$MAKENEWGLOSSARYCOM ${SOURCE.filebase}%s -s ${SOURCE.filebase}.ist -t ${SOURCE.filebase}%s -o ${SOURCE.filebase}%s" % (newglossary_suffix[ig][2],newglossary_suffix[ig][0],newglossary_suffix[ig][1]), "$MAKENEWGLOSSARYCOMSTR")
 
                 result = MakeNewGlossaryAction(newglfile, newglfile, env)
                 if result != 0:
diff --git a/test/Fortran/F95FLAGS.py b/test/Fortran/F95FLAGS.py
index de188585..8c3ce093 100644
--- a/test/Fortran/F95FLAGS.py
+++ b/test/Fortran/F95FLAGS.py
@@ -104,6 +104,12 @@ g95 = test.detect_tool(fc)
 
 
 if g95:
+    test.subdir('x')
+
+    test.write(['x','dummy.i'],
+"""
+# Exists only such that -Ix finds the directory...
+""")
 
     test.write("wrapper.py",
 """import os
diff --git a/test/Fortran/SHF95FLAGS.py b/test/Fortran/SHF95FLAGS.py
index b945bac1..8e758789 100644
--- a/test/Fortran/SHF95FLAGS.py
+++ b/test/Fortran/SHF95FLAGS.py
@@ -103,6 +103,13 @@ g95 = test.detect_tool(fc)
 
 if g95:
 
+    test.subdir('x')
+
+    test.write(['x','dummy.i'],
+"""
+# Exists only such that -Ix finds the directory...
+""")
+
     test.write("wrapper.py",
 """import os
 import sys
diff --git a/test/Repository/RMIC.py b/test/Repository/RMIC.py
index b214b4bd..886ccdbc 100644
--- a/test/Repository/RMIC.py
+++ b/test/Repository/RMIC.py
@@ -35,6 +35,27 @@ python = TestSCons.python
 test = TestSCons.TestSCons()
 
 where_javac, java_version = test.java_where_javac()
+
+# Try to get the major/minor Java version 
+curver = (1, 0)
+if java_version.count('.') == 1:
+    # Check Java version
+    major, minor = java_version.split('.')
+    try:
+        curver = (int(major), int(minor))
+    except:
+        pass
+
+# Check the version of the found Java compiler.
+# If it's 1.8 or higher, we skip the further RMIC test
+# because we'll get warnings about the deprecated API...
+# it's just not state-of-the-art anymore.
+# Note, how we allow simple version strings like "5" and
+# "6" to successfully pass this test.
+if curver >= (1, 8):
+    test.skip_test('The found version of javac is higher than 1.7, skipping test.\n')
+
+
 where_java = test.java_where_java()
 where_rmic = test.java_where_rmic()
 
diff --git a/test/TEX/variant_dir_newglossary.py b/test/TEX/variant_dir_newglossary.py
new file mode 100644
index 00000000..8604270c
--- /dev/null
+++ b/test/TEX/variant_dir_newglossary.py
@@ -0,0 +1,109 @@
+#!/usr/bin/env python
+#
+# __COPYRIGHT__
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
+
+"""
+Validate the use of \newglossary in TeX source files in conjuction
+with variant_dir. 
+
+Test configuration contributed by Kendrick Boyd.
+"""
+
+import os
+import TestSCons
+
+test = TestSCons.TestSCons()
+
+latex = test.where_is('latex')
+
+if not latex:
+    test.skip_test("Could not find latex; skipping test(s).\n")
+
+gloss = os.system('kpsewhich glossaries.sty')
+if gloss!=0:
+    test.skip_test("glossaries.sty not installed; skipping test(s).\n")
+
+
+test.subdir(['src'])
+
+test.write(['SConstruct'], r"""
+import os
+
+env = Environment(TOOLS = ['tex', 'latex'])
+Export(['env'])
+
+SConscript(os.path.join('src','SConscript'), variant_dir='build/', duplicate=1)
+""")
+
+test.write(['src', 'SConscript'], r"""
+Import('env')
+
+test_pdf = env.PDF(source='test.tex')
+
+""")
+
+test.write(['src', 'test.tex'], r"""
+\documentclass{report}
+
+\usepackage{glossaries}
+
+\newglossary[ntg]{notation}{nts}{nto}{List of Notation}
+
+\makeglossary
+
+\newglossaryentry{pi}{type=notation, name={$\pi$}, description={ratio
+    of circumference to diameter of a circle}}
+
+\begin{document}
+
+\glsaddall
+
+\printglossary[type=notation, style=list]
+
+\end{document}
+""")
+
+test.run(arguments = '.', stderr = None)
+
+files = [
+    'test.aux',
+    'test.fls',
+    'test.glg',
+    'test.glo',
+    'test.gls',
+    'test.ist',
+    'test.log',
+    'test.ntg',
+    'test.nto',
+    'test.nts',
+    'test.pdf',
+]
+
+for f in files:
+    test.must_exist(['build',f])
+    test.must_not_exist(['src',f])
+    
+
+test.pass_test()
diff --git a/test/YACC/live.py b/test/YACC/live.py
index 28e2186d..d567ec38 100644
--- a/test/YACC/live.py
+++ b/test/YACC/live.py
@@ -91,8 +91,6 @@ newline: '\n';
 test.write("file.yy", """\
 %token   GRAPH_T NODE_T EDGE_T DIGRAPH_T EDGEOP_T SUBGRAPH_T
 
-%pure_parser
-
 %%
 graph:        GRAPH_T
               ;