summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/BitKeeper.xml
diff options
context:
space:
mode:
Diffstat (limited to 'src/engine/SCons/Tool/BitKeeper.xml')
-rw-r--r--src/engine/SCons/Tool/BitKeeper.xml28
1 files changed, 27 insertions, 1 deletions
diff --git a/src/engine/SCons/Tool/BitKeeper.xml b/src/engine/SCons/Tool/BitKeeper.xml
index 9dd464a..3ca8e22 100644
--- a/src/engine/SCons/Tool/BitKeeper.xml
+++ b/src/engine/SCons/Tool/BitKeeper.xml
@@ -1,5 +1,5 @@
<!--
-Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 The SCons Foundation
+Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 The SCons Foundation
This file is processed by the bin/SConsDoc.py module.
See its __doc__ string for a discussion of the format.
@@ -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>