Add some documentation to the SCons-version-switching hack
[senf.git] / tools / scons-1.2.0 / engine / SCons / Tool / Subversion.py
1 """SCons.Tool.Subversion.py
2
3 Tool-specific initialization for Subversion.
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/Subversion.py 3842 2008/12/20 22:59:52 scons"
35
36 import os.path
37
38 import SCons.Action
39 import SCons.Builder
40 import SCons.Util
41
42 def generate(env):
43     """Add a Builder factory function and construction variables for
44     Subversion to an Environment."""
45
46     def SubversionFactory(repos, module='', env=env):
47         """ """
48         # fail if repos is not an absolute path name?
49         if module != '':
50             module = os.path.join(module, '')
51         act = SCons.Action.Action('$SVNCOM', '$SVNCOMSTR')
52         return SCons.Builder.Builder(action = act,
53                                      env = env,
54                                      SVNREPOSITORY = repos,
55                                      SVNMODULE = module)
56
57     #setattr(env, 'Subversion', SubversionFactory)
58     env.Subversion = SubversionFactory
59
60     env['SVN']      = 'svn'
61     env['SVNFLAGS'] = SCons.Util.CLVar('')
62     env['SVNCOM']   = '$SVN $SVNFLAGS cat $SVNREPOSITORY/$SVNMODULE$TARGET > $TARGET'
63
64 def exists(env):
65     return env.Detect('svn')