summaryrefslogtreecommitdiff
path: root/src/engine/SCons/Tool/RCS.xml
diff options
context:
space:
mode:
Diffstat (limited to 'src/engine/SCons/Tool/RCS.xml')
-rw-r--r--src/engine/SCons/Tool/RCS.xml42
1 files changed, 41 insertions, 1 deletions
diff --git a/src/engine/SCons/Tool/RCS.xml b/src/engine/SCons/Tool/RCS.xml
index a8049e6..6942164 100644
--- a/src/engine/SCons/Tool/RCS.xml
+++ b/src/engine/SCons/Tool/RCS.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.
@@ -59,3 +59,43 @@ If this is not set, then &cv-link-RCS_COCOM;
Options that are passed to the &cv-link-RCS_CO; command.
</summary>
</cvar>
+
+<scons_function name="RCS">
+<arguments signature="env">
+()
+</arguments>
+<summary>
+A factory function that
+returns a Builder object
+to be used to fetch source files
+from RCS.
+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.
+
+Examples:
+
+<example>
+env.SourceCode('.', env.RCS())
+</example>
+
+Note that
+&scons;
+will fetch source files
+from RCS subdirectories automatically,
+so configuring RCS
+as demonstrated in the above example
+should only be necessary if
+you are fetching from
+RCS,v
+files in the same
+directory as the source files,
+or if you need to explicitly specify RCS
+for a specific subdirectory.
+</summary>
+</scons_function>