Change the names of the Set{Build,Content}SignatureType() functions.

8 files changed, 347 insertions, 14 deletions

diff --git a/src/CHANGES.txt b/src/CHANGES.txt
index 04b543c..78a209e 100644
--- a/src/CHANGES.txt
+++ b/src/CHANGES.txt
@@ -50,6 +50,10 @@ RELEASE 0.14 - XXX
     Node's state, allowing it to be re-evaluated by continuous
     integration build interfaces.
 
+  - Change the name of the Set{Build,Content}SignatureType() functions
+    to {Target,Source}Signatures().  Deprecate the old names but support
+    them for backwards compatibility.
+
   From Stefan Reichor:
 
   - Add support for using Ghostscript to convert Postscript to PDF files.
diff --git a/src/RELEASE.txt b/src/RELEASE.txt
index 493ed00..b943cef 100644
--- a/src/RELEASE.txt
+++ b/src/RELEASE.txt
@@ -30,6 +30,10 @@ RELEASE 0.14 - XXX
   - Tool specifications no longer take a "platform" argument.
     XXX
 
+  - The SetBuildSignatureType() and SetContentSignatureType() functions
+    have been deprecated.  The new names are TargetSignatures() and
+    SourceSignatures().
+
   Please note the following important changes since release 0.11:
 
   - The default behavior of SCons is now to change to the directory in
diff --git a/src/engine/SCons/Script/SConscript.py b/src/engine/SCons/Script/SConscript.py
index c0d82ce..7c20732 100644
--- a/src/engine/SCons/Script/SConscript.py
+++ b/src/engine/SCons/Script/SConscript.py
@@ -360,6 +360,12 @@ def GetLaunchDir():
     return launch_dir
 
 def SetBuildSignatureType(type):
+    SCons.Warnings.warn(SCons.Warnings.DeprecatedWarning,
+                        "The SetBuildSignatureType() function has been deprecated;\n" +\
+                        "\tuse the TargetSignatures() function instead.")
+    TargetSignatures(type)
+
+def TargetSignatures(type):
     import SCons.Sig
     if type == 'build':
         SCons.Sig.build_signature = 1
@@ -369,6 +375,12 @@ def SetBuildSignatureType(type):
         raise SCons.Errors.UserError, "Unknown build signature type '%s'"%type
 
 def SetContentSignatureType(type):
+    SCons.Warnings.warn(SCons.Warnings.DeprecatedWarning,
+                        "The SetContentSignatureType() function has been deprecated;\n" +\
+                        "\tuse the SourceSignatures() function instead.")
+    SourceSignatures(type)
+
+def SourceSignatures(type):
     if type == 'MD5':
         import SCons.Sig.MD5
         SCons.Script.sig_module = SCons.Sig.MD5
@@ -500,9 +512,11 @@ def BuildDefaultGlobals():
     globals['SetJobs']           = SetJobs
     globals['SharedLibrary']     = SCons.Defaults.SharedLibrary
     globals['SharedObject']      = SCons.Defaults.SharedObject
+    globals['SourceSignatures']  = SourceSignatures
     globals['Split']             = SCons.Util.Split
     globals['StaticLibrary']     = SCons.Defaults.StaticLibrary
     globals['StaticObject']      = SCons.Defaults.StaticObject
+    globals['TargetSignatures']  = TargetSignatures
     globals['Tool']              = SCons.Tool.Tool
     globals['WhereIs']           = SCons.Util.WhereIs
     return globals
diff --git a/test/Alias.py b/test/Alias.py
index f965071..6608d72 100644
--- a/test/Alias.py
+++ b/test/Alias.py
@@ -126,7 +126,7 @@ test.run(arguments = 'f1.out',
 test.up_to_date(arguments = 'f1.out')
 
 test.write('SConstruct', """
-SetBuildSignatureType('content')
+TargetSignatures('content')
 B = Builder(action = r"%s build.py $TARGET $SOURCES")
 env = Environment()
 env['BUILDERS']['B'] = B
@@ -157,7 +157,7 @@ test.up_to_date(arguments = 'f1.out')
 
 test.write('SConstruct', """
 env=Environment()
-SetBuildSignatureType('content')
+TargetSignatures('content')
 env.Alias('C', 'D')
 env.Alias('B', 'C')
 env.Alias('A', 'B')
diff --git a/test/SetBuildSignatureType.py b/test/SetBuildSignatureType.py
index 4ed19d1..0d625a8 100644
--- a/test/SetBuildSignatureType.py
+++ b/test/SetBuildSignatureType.py
@@ -28,6 +28,13 @@ import TestSCons
 
 test = TestSCons.TestSCons()
 
+warning = """\
+
+scons: warning: The SetBuildSignatureType() function has been deprecated;
+	use the TargetSignatures() function instead.
+File "SConstruct", line %d, in ?
+"""
+
 test.write('SConstruct', """
 env = Environment()
 
@@ -52,10 +59,12 @@ test.run(arguments='foo.out.out',
          stdout=test.wrap_stdout("""\
 copy2("foo.out", "foo.in")
 copy1("foo.out.out", "foo.out")
-"""))
+"""),
+         stderr=warning%16)
 
 test.run(arguments='foo.out.out',
-         stdout=test.wrap_stdout('scons: "foo.out.out" is up to date.\n'))
+         stdout=test.wrap_stdout('scons: "foo.out.out" is up to date.\n'),
+         stderr=warning%16)
 
 test.write('SConstruct', """
 env = Environment()
@@ -80,7 +89,8 @@ test.run(arguments='foo.out.out',
          stdout=test.wrap_stdout("""\
 copy2("foo.out", "foo.in")
 scons: "foo.out.out" is up to date.
-"""))
+"""),
+         stderr=warning%17)
 
 test.write('SConstruct', """
 env = Environment()
@@ -104,7 +114,8 @@ SetBuildSignatureType('build')
 test.run(arguments='foo.out.out',
          stdout=test.wrap_stdout("""\
 copy1("foo.out.out", "foo.out")
-"""))
+"""),
+         stderr=warning%17)
 
 test.write('SConstruct', """
 env = Environment()
@@ -128,7 +139,8 @@ test.run(arguments='foo.out.out',
          stdout=test.wrap_stdout("""\
 copy2("foo.out", "foo.in")
 copy1("foo.out.out", "foo.out")
-"""))
+"""),
+         stderr=warning%16)
 
 
 test.pass_test()
diff --git a/test/SetContentSignatureType.py b/test/SetContentSignatureType.py
index 72b1daa..7f161fe 100644
--- a/test/SetContentSignatureType.py
+++ b/test/SetContentSignatureType.py
@@ -32,6 +32,13 @@ import TestSCons
 
 test = TestSCons.TestSCons()
 
+warning = """\
+
+scons: warning: The SetContentSignatureType() function has been deprecated;
+	use the SourceSignatures() function instead.
+File "SConstruct", line %d, in ?
+"""
+
 test.write('SConstruct', """
 def build(env, target, source):
     open(str(target[0]), 'wt').write(open(str(source[0]), 'rt').read())
@@ -50,7 +57,8 @@ test.write('f2.in', "f2.in\n")
 test.write('f3.in', "f3.in\n")
 test.write('f4.in', "f4.in\n")
 
-test.run(arguments = 'f1.out f3.out')
+test.run(arguments = 'f1.out f3.out',
+         stderr = warning%11)
 
 test.run(arguments = 'f1.out f2.out f3.out f4.out',
          stdout = test.wrap_stdout("""\
@@ -58,7 +66,8 @@ scons: "f1.out" is up to date.
 build("f2.out", "f2.in")
 scons: "f3.out" is up to date.
 build("f4.out", "f4.in")
-"""))
+"""),
+         stderr = warning%11)
 
 os.utime(test.workpath('f1.in'), 
          (os.path.getatime(test.workpath('f1.in')),
@@ -73,7 +82,8 @@ build("f1.out", "f1.in")
 scons: "f2.out" is up to date.
 build("f3.out", "f3.in")
 scons: "f4.out" is up to date.
-"""))
+"""),
+         stderr = warning%11)
 
 test.write('SConstruct', """
 def build(env, target, source):
@@ -93,7 +103,8 @@ test.write('f2.in', "f2.in\n")
 test.write('f3.in', "f3.in\n")
 test.write('f4.in', "f4.in\n")
 
-test.run(arguments = 'f1.out f3.out')
+test.run(arguments = 'f1.out f3.out',
+         stderr = warning%11)
 
 test.run(arguments = 'f1.out f2.out f3.out f4.out',
          stdout = test.wrap_stdout("""\
@@ -101,7 +112,8 @@ scons: "f1.out" is up to date.
 build("f2.out", "f2.in")
 scons: "f3.out" is up to date.
 build("f4.out", "f4.in")
-"""))
+"""),
+         stderr = warning%11)
 
 os.utime(test.workpath('f1.in'), 
          (os.path.getatime(test.workpath('f1.in')),
@@ -111,7 +123,8 @@ os.utime(test.workpath('f3.in'),
           os.path.getmtime(test.workpath('f3.in'))+10))
 
 test.run(arguments = 'f1.out f2.out f3.out f4.out',
-         stdout = test.wrap_stdout('scons: "f1.out" is up to date.\nscons: "f2.out" is up to date.\nscons: "f3.out" is up to date.\nscons: "f4.out" is up to date.\n'))
+         stdout = test.wrap_stdout('scons: "f1.out" is up to date.\nscons: "f2.out" is up to date.\nscons: "f3.out" is up to date.\nscons: "f4.out" is up to date.\n'),
+         stderr = warning%11)
 
 test.write('SConstruct', """
 def build(env, target, source):
@@ -148,4 +161,5 @@ SetContentSignatureType('timestamp')
 """)
 
 test.run(arguments = 'f1.out f2.out f3.out f4.out',
-         stdout = test.wrap_stdout(''))
+         stdout = test.wrap_stdout(''),
+         stderr = warning%11)
diff --git a/test/SourceSignatures.py b/test/SourceSignatures.py
new file mode 100644
index 0000000..979003a
--- /dev/null
+++ b/test/SourceSignatures.py
@@ -0,0 +1,151 @@
+#!/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 imp
+import os
+import os.path
+
+import TestSCons
+
+test = TestSCons.TestSCons()
+
+test.write('SConstruct', """
+def build(env, target, source):
+    open(str(target[0]), 'wt').write(open(str(source[0]), 'rt').read())
+B = Builder(action = build)
+env = Environment(BUILDERS = { 'B' : B })
+env.B(target = 'f1.out', source = 'f1.in')
+env.B(target = 'f2.out', source = 'f2.in')
+env.B(target = 'f3.out', source = 'f3.in')
+env.B(target = 'f4.out', source = 'f4.in')
+
+SourceSignatures('timestamp')
+""")
+
+test.write('f1.in', "f1.in\n")
+test.write('f2.in', "f2.in\n")
+test.write('f3.in', "f3.in\n")
+test.write('f4.in', "f4.in\n")
+
+test.run(arguments = 'f1.out f3.out')
+
+test.run(arguments = 'f1.out f2.out f3.out f4.out',
+         stdout = test.wrap_stdout("""\
+scons: "f1.out" is up to date.
+build("f2.out", "f2.in")
+scons: "f3.out" is up to date.
+build("f4.out", "f4.in")
+"""))
+
+os.utime(test.workpath('f1.in'), 
+         (os.path.getatime(test.workpath('f1.in')),
+          os.path.getmtime(test.workpath('f1.in'))+10))
+os.utime(test.workpath('f3.in'), 
+         (os.path.getatime(test.workpath('f3.in')),
+          os.path.getmtime(test.workpath('f3.in'))+10))
+
+test.run(arguments = 'f1.out f2.out f3.out f4.out',
+         stdout = test.wrap_stdout("""\
+build("f1.out", "f1.in")
+scons: "f2.out" is up to date.
+build("f3.out", "f3.in")
+scons: "f4.out" is up to date.
+"""))
+
+test.write('SConstruct', """
+def build(env, target, source):
+    open(str(target[0]), 'wt').write(open(str(source[0]), 'rt').read())
+B = Builder(action = build)
+env = Environment(BUILDERS = { 'B' : B })
+env.B(target = 'f1.out', source = 'f1.in')
+env.B(target = 'f2.out', source = 'f2.in')
+env.B(target = 'f3.out', source = 'f3.in')
+env.B(target = 'f4.out', source = 'f4.in')
+
+SourceSignatures('MD5')
+""")
+
+test.write('f1.in', "f1.in\n")
+test.write('f2.in', "f2.in\n")
+test.write('f3.in', "f3.in\n")
+test.write('f4.in', "f4.in\n")
+
+test.run(arguments = 'f1.out f3.out')
+
+test.run(arguments = 'f1.out f2.out f3.out f4.out',
+         stdout = test.wrap_stdout("""\
+scons: "f1.out" is up to date.
+build("f2.out", "f2.in")
+scons: "f3.out" is up to date.
+build("f4.out", "f4.in")
+"""))
+
+os.utime(test.workpath('f1.in'), 
+         (os.path.getatime(test.workpath('f1.in')),
+          os.path.getmtime(test.workpath('f1.in'))+10))
+os.utime(test.workpath('f3.in'), 
+         (os.path.getatime(test.workpath('f3.in')),
+          os.path.getmtime(test.workpath('f3.in'))+10))
+
+test.run(arguments = 'f1.out f2.out f3.out f4.out',
+         stdout = test.wrap_stdout('scons: "f1.out" is up to date.\nscons: "f2.out" is up to date.\nscons: "f3.out" is up to date.\nscons: "f4.out" is up to date.\n'))
+
+test.write('SConstruct', """
+def build(env, target, source):
+    open(str(target[0]), 'wt').write(open(str(source[0]), 'rt').read())
+B = Builder(action = build)
+env = Environment(BUILDERS = { 'B' : B })
+env.B(target = 'f1.out', source = 'f1.in')
+env.B(target = 'f2.out', source = 'f2.in')
+env.B(target = 'f3.out', source = 'f3.in')
+env.B(target = 'f4.out', source = 'f4.in')
+""")
+
+test.run(arguments = 'f1.out f2.out f3.out f4.out',
+         stdout = test.wrap_stdout("""\
+scons: "f1.out" is up to date.
+scons: "f2.out" is up to date.
+scons: "f3.out" is up to date.
+scons: "f4.out" is up to date.
+"""))
+
+test.pass_test()
+
+test.write('SConstruct', """
+def build(env, target, source):
+    open(str(target[0]), 'wt').write(open(str(source[0]), 'rt').read())
+B = Builder(action = build)
+env = Environment(BUILDERS = { 'B' : B })
+env.B(target = 'f1.out', source = 'f1.in')
+env.B(target = 'f2.out', source = 'f2.in')
+env.B(target = 'f3.out', source = 'f3.in')
+env.B(target = 'f4.out', source = 'f4.in')
+
+SourceSignatures('timestamp')
+""")
+
+test.run(arguments = 'f1.out f2.out f3.out f4.out',
+         stdout = test.wrap_stdout(''))
diff --git a/test/TargetSignatures.py b/test/TargetSignatures.py
new file mode 100644
index 0000000..036427e
--- /dev/null
+++ b/test/TargetSignatures.py
@@ -0,0 +1,134 @@
+#!/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 TestSCons
+
+test = TestSCons.TestSCons()
+
+test.write('SConstruct', """
+env = Environment()
+
+def copy1(env, source, target):
+    open(str(target[0]), 'wb').write(open(str(source[0]), 'rb').read())
+
+def copy2(env, source, target):
+    return copy1(env, source, target)
+
+env['BUILDERS']['Copy1'] = Builder(action=copy1)
+env['BUILDERS']['Copy2'] = Builder(action=copy2)
+
+env.Copy2('foo.out', 'foo.in')
+env.Copy1('foo.out.out', 'foo.out')
+
+TargetSignatures('content')
+""")
+
+test.write('foo.in', 'foo.in')
+
+test.run(arguments='foo.out.out',
+         stdout=test.wrap_stdout("""\
+copy2("foo.out", "foo.in")
+copy1("foo.out.out", "foo.out")
+"""))
+
+test.run(arguments='foo.out.out',
+         stdout=test.wrap_stdout('scons: "foo.out.out" is up to date.\n'))
+
+test.write('SConstruct', """
+env = Environment()
+
+def copy1(env, source, target):
+    open(str(target[0]), 'wb').write(open(str(source[0]), 'rb').read())
+
+def copy2(env, source, target):
+    # added this line
+    return copy1(env, source, target)
+
+env['BUILDERS']['Copy1'] = Builder(action=copy1)
+env['BUILDERS']['Copy2'] = Builder(action=copy2)
+
+env.Copy2('foo.out', 'foo.in')
+env.Copy1('foo.out.out', 'foo.out')
+
+TargetSignatures('content')
+""")
+
+test.run(arguments='foo.out.out',
+         stdout=test.wrap_stdout("""\
+copy2("foo.out", "foo.in")
+scons: "foo.out.out" is up to date.
+"""))
+
+test.write('SConstruct', """
+env = Environment()
+
+def copy1(env, source, target):
+    open(str(target[0]), 'wb').write(open(str(source[0]), 'rb').read())
+
+def copy2(env, source, target):
+    # added this line
+    return copy1(env, source, target)
+
+env['BUILDERS']['Copy1'] = Builder(action=copy1)
+env['BUILDERS']['Copy2'] = Builder(action=copy2)
+
+env.Copy2('foo.out', 'foo.in')
+env.Copy1('foo.out.out', 'foo.out')
+
+TargetSignatures('build')
+""")
+
+test.run(arguments='foo.out.out',
+         stdout=test.wrap_stdout("""\
+copy1("foo.out.out", "foo.out")
+"""))
+
+test.write('SConstruct', """
+env = Environment()
+
+def copy1(env, source, target):
+    open(str(target[0]), 'wb').write(open(str(source[0]), 'rb').read())
+
+def copy2(env, source, target):
+    return copy1(env, source, target)
+
+env['BUILDERS']['Copy1'] = Builder(action=copy1)
+env['BUILDERS']['Copy2'] = Builder(action=copy2)
+
+env.Copy2('foo.out', 'foo.in')
+env.Copy1('foo.out.out', 'foo.out')
+
+TargetSignatures('build')
+""")
+
+test.run(arguments='foo.out.out',
+         stdout=test.wrap_stdout("""\
+copy2("foo.out", "foo.in")
+copy1("foo.out.out", "foo.out")
+"""))
+
+
+test.pass_test()