Document the -f option correctly, support building a parallel tree by pointing to an SConstruct file using -f.

7 files changed, 154 insertions, 26 deletions

diff --git a/doc/man/scons.1 b/doc/man/scons.1
index bc28d33..f0845d6 100644
--- a/doc/man/scons.1
+++ b/doc/man/scons.1
@@ -65,11 +65,7 @@ configuration from the first file found.
 An alternate file name may be
 specified via the 
 .B -f
-option. If the specified file is not
-in the local directory, 
-.B scons 
-will internally change its working
-directory (chdir) to the directory containing the file.
+option.
 
 The
 .I SConstruct
@@ -476,11 +472,6 @@ variables from the SConscript files.
 Use 
 .I file 
 as the initial SConscript file.
-If 
-.I file
-is in another directory,
-.B scons 
-will change to that directory before building targets.
 
 .TP 
 -h, --help
diff --git a/src/CHANGES.txt b/src/CHANGES.txt
index 2ddcf5a..a6406a7 100644
--- a/src/CHANGES.txt
+++ b/src/CHANGES.txt
@@ -67,6 +67,14 @@ RELEASE 0.12 - XXX
 
   - Add an explicit Exit() function for terminating early.
 
+  - Change the documentation to correctly describe that the -f option
+    doesn't change to the directory in which the specified file lives.
+    
+  - Support changing directories locally with SConscript directory
+    path names relative to any SConstruct file specified with -f.
+    This allows you to build in another directory by simply changing
+    there and pointing at the SConstruct file in another directory.
+
   From Lachlan O'Dea:
 
   - Add SharedObject() support to the masm tool.
diff --git a/src/engine/SCons/Node/FS.py b/src/engine/SCons/Node/FS.py
index 551ae06..b0bc3e4 100644
--- a/src/engine/SCons/Node/FS.py
+++ b/src/engine/SCons/Node/FS.py
@@ -366,6 +366,7 @@ class FS:
             self.pathTop = path
         self.Root = {}
         self.Top = None
+        self.SConstruct = None
         self.CachePath = None
         self.cache_force = None
         self.cache_show = None
@@ -373,6 +374,9 @@ class FS:
     def set_toplevel_dir(self, path):
         assert not self.Top, "You can only set the top-level path on an FS object that has not had its File, Dir, or Entry methods called yet."
         self.pathTop = path
+
+    def set_SConstruct(self, path):
+        self.SConstruct = self.File(path)
         
     def __setTopLevelDir(self):
         if not self.Top:
diff --git a/src/engine/SCons/Node/FSTests.py b/src/engine/SCons/Node/FSTests.py
index 10e4676..3a862eb 100644
--- a/src/engine/SCons/Node/FSTests.py
+++ b/src/engine/SCons/Node/FSTests.py
@@ -1265,6 +1265,14 @@ class get_actionsTestCase(unittest.TestCase):
         a = dir.get_actions()
         assert a == [], a
 
+class SConstructTestCase(unittest.TestCase):
+    def runTest(self):
+        """Test setting the SConstruct file"""
+
+        fs = SCons.Node.FS.FS()
+        fs.set_SConstruct('xxx')
+        assert fs.SConstruct.path == 'xxx'
+
 class CacheDirTestCase(unittest.TestCase):
     def runTest(self):
         """Test CacheDir functionality"""
@@ -1397,6 +1405,7 @@ if __name__ == "__main__":
     suite.addTest(has_builderTestCase())
     suite.addTest(prepareTestCase())
     suite.addTest(get_actionsTestCase())
+    suite.addTest(SConstructTestCase())
     suite.addTest(CacheDirTestCase())
     if not unittest.TextTestRunner().run(suite).wasSuccessful():
         sys.exit(1)
diff --git a/src/engine/SCons/Script/SConscript.py b/src/engine/SCons/Script/SConscript.py
index d9da651..ab071e0 100644
--- a/src/engine/SCons/Script/SConscript.py
+++ b/src/engine/SCons/Script/SConscript.py
@@ -182,6 +182,10 @@ def GetSConscriptFilenames(ls, kw):
 def SConscript(*ls, **kw):
     files, exports = GetSConscriptFilenames(ls, kw)
 
+    default_fs = SCons.Node.FS.default_fs
+    top = default_fs.Top
+    sd = default_fs.SConstruct.rfile().dir
+
     # evaluate each SConscript file
     results = []
     for fn in files:
@@ -195,19 +199,20 @@ def SConscript(*ls, **kw):
                 if isinstance(fn, SCons.Node.Node):
                     f = fn
                 else:
-                    f = SCons.Node.FS.default_fs.File(str(fn))
+                    f = default_fs.File(str(fn))
                 _file_ = None
-                old_dir = SCons.Node.FS.default_fs.getcwd()
-                SCons.Node.FS.default_fs.chdir(SCons.Node.FS.default_fs.Dir('#'),
-                                               change_os_dir=1)
+                old_dir = default_fs.getcwd()
+
+                # Change directory to the top of the source
+                # tree to make sure the os's cwd and the cwd of
+                # SCons.Node.FS.default_fs match so we can open the
+                # SConscript.
+                default_fs.chdir(top, change_os_dir=1)
                 if f.rexists():
-                    # Change directory to top of source tree to make sure
-                    # the os's cwd and the cwd of SCons.Node.FS.default_fs
-                    # match so we can open the SConscript.
                     _file_ = open(f.rstr(), "r")
                 elif f.has_builder():
                     # The SConscript file apparently exists in a source
-                    # code management system.  Build it, but then remove
+                    # code management system.  Build it, but then clear
                     # the builder so that it doesn't get built *again*
                     # during the actual build phase.
                     f.build()
@@ -216,11 +221,22 @@ def SConscript(*ls, **kw):
                     if os.path.exists(s):
                         _file_ = open(s, "r")
                 if _file_:
-                    SCons.Node.FS.default_fs.chdir(f.dir,
-                                                   change_os_dir=sconscript_chdir)
-                    # prepend the SConscript directory to sys.path so
-                    # that Python modules in the SConscript directory can
-                    # be easily imported
+                    # Chdir to the SConscript directory.  Use a path
+                    # name relative to the SConstruct file so that if
+                    # we're using the -f option, we're essentially
+                    # creating a parallel SConscript directory structure
+                    # in our local directory tree.
+                    #
+                    # XXX This is broken for multiple-repository cases
+                    # where the SConstruct and SConscript files might be
+                    # in different Repositories.  For now, cross that
+                    # bridge when someone comes to it.
+                    ldir = default_fs.Dir(f.dir.get_path(sd))
+                    default_fs.chdir(ldir, change_os_dir=sconscript_chdir)
+
+                    # Append the SConscript directory to the beginning
+                    # of sys.path so Python modules in the SConscript
+                    # directory can be easily imported.
                     sys.path = [ f.dir.abspath ] + sys.path
 
                     # This is the magic line that actually reads up and
@@ -237,10 +253,9 @@ def SConscript(*ls, **kw):
         finally:
             sys.path = old_sys_path
             frame = stack.pop()
-            SCons.Node.FS.default_fs.chdir(frame.prev_dir)
+            default_fs.chdir(frame.prev_dir)
             if old_dir:
-                SCons.Node.FS.default_fs.chdir(old_dir,
-                                               change_os_dir=sconscript_chdir)
+                default_fs.chdir(old_dir, change_os_dir=sconscript_chdir)
 
             results.append(frame.retval)
 
diff --git a/src/engine/SCons/Script/__init__.py b/src/engine/SCons/Script/__init__.py
index ca0d50e..1f9daf5 100644
--- a/src/engine/SCons/Script/__init__.py
+++ b/src/engine/SCons/Script/__init__.py
@@ -742,6 +742,8 @@ def _main():
     if not scripts:
         raise SCons.Errors.UserError, "No SConstruct file found."
 
+    SCons.Node.FS.default_fs.set_SConstruct(scripts[0])
+
     class Unbuffered:
         def __init__(self, file):
             self.file = file
diff --git a/test/Repository/option-f.py b/test/Repository/option-f.py
new file mode 100644
index 0000000..4615104
--- /dev/null
+++ b/test/Repository/option-f.py
@@ -0,0 +1,99 @@
+#!/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__"
+
+import os.path
+import TestSCons
+
+test = TestSCons.TestSCons()
+
+test.subdir('work', 'repository', ['repository', 'src'])
+
+work_aaa = test.workpath('work', 'aaa')
+work_bbb = test.workpath('work', 'bbb')
+work_ccc = test.workpath('work', 'ccc')
+work_src_xxx = test.workpath('work', 'src', 'xxx')
+work_src_yyy = test.workpath('work', 'src', 'yyy')
+
+opts = "-f " + test.workpath('repository', 'SConstruct')
+
+test.write(['repository', 'SConstruct'], """\
+Repository(r'%s')
+def cat(env, source, target):
+    target = str(target[0])
+    source = map(str, source)
+    f = open(target, "wb")
+    for src in source:
+        f.write(open(src, "rb").read())
+    f.close()
+
+env = Environment(BUILDERS={'Build':Builder(action=cat)})
+env.Build('aaa.out', 'aaa.in')
+env.Build('bbb.out', 'bbb.in')
+env.Build('ccc.out', 'ccc.in')
+SConscript('src/SConscript', "env")
+""" % test.workpath('repository'))
+
+test.write(['repository', 'src', 'SConscript'], """
+Import("env")
+env.Build('xxx.out', 'xxx.in')
+env.Build('yyy.out', 'yyy.in')
+""")
+
+test.write(['repository', 'aaa.in'], "repository/aaa.in\n")
+test.write(['repository', 'bbb.in'], "repository/bbb.in\n")
+test.write(['repository', 'ccc.in'], "repository/ccc.in\n")
+
+test.write(['repository', 'src', 'xxx.in'], "repository/src/xxx.in\n")
+test.write(['repository', 'src', 'yyy.in'], "repository/src/yyy.in\n")
+
+#
+# Make the repository non-writable,
+# so we'll detect if we try to write into it accidentally.
+test.writable('repository', 0)
+
+#
+test.run(chdir = 'work', options = opts, arguments = 'aaa.out')
+
+test.fail_test(test.read(['work', 'aaa.out']) != "repository/aaa.in\n")
+test.fail_test(os.path.exists(test.workpath('work', 'bbb.out')))
+test.fail_test(os.path.exists(test.workpath('work', 'ccc.out')))
+test.fail_test(os.path.exists(test.workpath('work', 'src', 'xxx.out')))
+test.fail_test(os.path.exists(test.workpath('work', 'src', 'yyy.out')))
+
+test.run(chdir = 'work', options = opts, arguments = 'bbb.out src')
+
+test.fail_test(test.read(['work', 'bbb.out']) != "repository/bbb.in\n")
+test.fail_test(os.path.exists(test.workpath('work', 'ccc.out')))
+test.fail_test(test.read(['work', 'src', 'xxx.out']) != "repository/src/xxx.in\n")
+test.fail_test(test.read(['work', 'src', 'yyy.out']) != "repository/src/yyy.in\n")
+
+#
+test.run(chdir = 'work', options = opts, arguments = '.')
+
+test.fail_test(test.read(['work', 'ccc.out']) != "repository/ccc.in\n")
+
+#
+test.pass_test()