Add some documentation to the SCons-version-switching hack
[senf.git] / scons / scons-1.2.0 / engine / SCons / Tool / RCS.py
1 """SCons.Tool.RCS.py
2
3 Tool-specific initialization for RCS.
4
5 There normally shouldn't be any need to import this module directly.
6 It will usually be imported through the generic SCons.Tool.Tool()
7 selection method.
8
9 """
10
11 #
12 # Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 The SCons Foundation
13 #
14 # Permission is hereby granted, free of charge, to any person obtaining
15 # a copy of this software and associated documentation files (the
16 # "Software"), to deal in the Software without restriction, including
17 # without limitation the rights to use, copy, modify, merge, publish,
18 # distribute, sublicense, and/or sell copies of the Software, and to
19 # permit persons to whom the Software is furnished to do so, subject to
20 # the following conditions:
21 #
22 # The above copyright notice and this permission notice shall be included
23 # in all copies or substantial portions of the Software.
24 #
25 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
26 # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
27 # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
29 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
30 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
31 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
32 #
33
34 __revision__ = "src/engine/SCons/Tool/RCS.py 3842 2008/12/20 22:59:52 scons"
35
36 import SCons.Action
37 import SCons.Builder
38 import SCons.Util
39
40 def generate(env):
41     """Add a Builder factory function and construction variables for
42     RCS to an Environment."""
43
44     def RCSFactory(env=env):
45         """ """
46         act = SCons.Action.Action('$RCS_COCOM', '$RCS_COCOMSTR')
47         return SCons.Builder.Builder(action = act, env = env)
48
49     #setattr(env, 'RCS', RCSFactory)
50     env.RCS = RCSFactory
51
52     env['RCS']          = 'rcs'
53     env['RCS_CO']       = 'co'
54     env['RCS_COFLAGS']  = SCons.Util.CLVar('')
55     env['RCS_COCOM']    = '$RCS_CO $RCS_COFLAGS $TARGET'
56
57 def exists(env):
58     return env.Detect('rcs')