Add some documentation to the SCons-version-switching hack
[senf.git] / tools / scons-1.2.0 / engine / SCons / Sig.py
1 #
2 # Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 The SCons Foundation
3 #
4 # Permission is hereby granted, free of charge, to any person obtaining
5 # a copy of this software and associated documentation files (the
6 # "Software"), to deal in the Software without restriction, including
7 # without limitation the rights to use, copy, modify, merge, publish,
8 # distribute, sublicense, and/or sell copies of the Software, and to
9 # permit persons to whom the Software is furnished to do so, subject to
10 # the following conditions:
11 #
12 # The above copyright notice and this permission notice shall be included
13 # in all copies or substantial portions of the Software.
14 #
15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
16 # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
17 # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
19 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
20 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
21 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22 #
23
24 __revision__ = "src/engine/SCons/Sig.py 3842 2008/12/20 22:59:52 scons"
25
26 __doc__ = """Place-holder for the old SCons.Sig module hierarchy
27
28 This is no longer used, but code out there (such as the NSIS module on
29 the SCons wiki) may try to import SCons.Sig.  If so, we generate a warning
30 that points them to the line that caused the import, and don't die.
31
32 If someone actually tried to use the sub-modules or functions within
33 the package (for example, SCons.Sig.MD5.signature()), then they'll still
34 get an AttributeError, but at least they'll know where to start looking.
35 """
36
37 import SCons.Util
38 import SCons.Warnings
39
40 msg = 'The SCons.Sig module no longer exists.\n' \
41       '    Remove the following "import SCons.Sig" line to eliminate this warning:'
42
43 SCons.Warnings.warn(SCons.Warnings.DeprecatedWarning, msg)
44
45 default_calc = None
46 default_module = None
47
48 class MD5Null(SCons.Util.Null):
49     def __repr__(self):
50         return "MD5Null()"
51
52 class TimeStampNull(SCons.Util.Null):
53     def __repr__(self):
54         return "TimeStampNull()"
55
56 MD5 = MD5Null()
57 TimeStamp = TimeStampNull()