summaryrefslogtreecommitdiffstats
path: root/src/engine/SCons/Tool/BitKeeper.xml
diff options
context:
space:
mode:
authorSteven Knight <knight@baldmt.com>2010-07-21 16:42:26 (GMT)
committerSteven Knight <knight@baldmt.com>2010-07-21 16:42:26 (GMT)
commitf47c9af3748b0eb9c6f0b1d0f8aeec1dd9a0bfa1 (patch)
tree571c2f903cc940142c5abfc7a56ed48f4b547bdc /src/engine/SCons/Tool/BitKeeper.xml
parent324f4aa55703916b94e7660f7f65d29f4bc9c1e5 (diff)
downloadSCons-f47c9af3748b0eb9c6f0b1d0f8aeec1dd9a0bfa1.zip
SCons-f47c9af3748b0eb9c6f0b1d0f8aeec1dd9a0bfa1.tar.gz
SCons-f47c9af3748b0eb9c6f0b1d0f8aeec1dd9a0bfa1.tar.bz2
Move the authoritative source for functions from the man page to various
.xml files (some new, some updated) next to the modules that implement them. Generate the man page using the output generated from the .xml file by bin/scons-proc.py.
Diffstat (limited to 'src/engine/SCons/Tool/BitKeeper.xml')
-rw-r--r--src/engine/SCons/Tool/BitKeeper.xml26
1 files changed, 26 insertions, 0 deletions
diff --git a/src/engine/SCons/Tool/BitKeeper.xml b/src/engine/SCons/Tool/BitKeeper.xml
index d0e42d7..ec20901 100644
--- a/src/engine/SCons/Tool/BitKeeper.xml
+++ b/src/engine/SCons/Tool/BitKeeper.xml
@@ -56,3 +56,29 @@ Options that are passed to the BitKeeper
subcommand.
</summary>
</cvar>
+
+<scons_function name="BitKeeper">
+<arguments signature="env">
+()
+</arguments>
+<summary>
+A factory function that
+returns a Builder object
+to be used to fetch source files
+using BitKeeper.
+The returned Builder
+is intended to be passed to the
+&f-SourceCode;
+function.
+
+This function is deprecated. For details, see the entry for the
+&f-SourceCode;
+function.
+
+Example:
+
+<example>
+env.SourceCode('.', env.BitKeeper())
+</example>
+</summary>
+</scons_function>