http://scons.tigris.org/issues/show_bug.cgi?id=2365

Start the deprecation cycle for SourceCode() and its related factory functions.
Deprecation messages are added to the functions.  Regression tests are modified
to deal with the messages being generated.  Documentation is updated.

1 files changed, 32 insertions, 1 deletions

diff --git a/doc/man/scons.1 b/doc/man/scons.1
index fd2baa3..da6c918 100644
--- a/doc/man/scons.1
+++ b/doc/man/scons.1
@@ -2786,6 +2786,10 @@ is intended to be passed to the
 .B SourceCode
 function.
 
+This function is deprecated.  For details, see the entry for the
+.B SourceCode
+function.
+
 Example:
 
 .ES
@@ -3168,6 +3172,10 @@ replicate part of the repository
 directory hierarchy in your
 local build directory.
 
+This function is deprecated.  For details, see the entry for the
+.B SourceCode
+function.
+
 Examples:
 
 .ES
@@ -3735,7 +3743,7 @@ in the path specified by
 .IR dirs .
 .I dirs
 may be a list of directory names or a single directory name.
-In addition to searching for files that exist in the filesytem,
+In addition to searching for files that exist in the filesystem,
 this function also searches for derived files
 that have not yet been built.
 
@@ -4719,6 +4727,10 @@ is intended to be passed to the
 .B SourceCode
 function.
 
+This function is deprecated.  For details, see the entry for the
+.B SourceCode
+function.
+
 Example:
 
 .ES
@@ -5012,6 +5024,10 @@ is intended to be passed to the
 .B SourceCode
 function:
 
+This function is deprecated.  For details, see the entry for the
+.B SourceCode
+function.
+
 Examples:
 
 .ES
@@ -5180,6 +5196,10 @@ is intended to be passed to the
 .B SourceCode
 function.
 
+This function is deprecated.  For details, see the entry for the
+.B SourceCode
+function.
+
 Example:
 
 .ES
@@ -5638,6 +5658,13 @@ function.
 .RI SourceCode( entries ", " builder )
 .TP
 .RI env.SourceCode( entries ", " builder )
+This function and its associate factory functions are deprecated.
+There is no replacement.
+The intended use was to keep a local tree in sync with an archive,
+but in actuality the function only causes the archive
+to be fetched on the first run.
+Synchronizing with the archive is best done external to SCons.
+
 Arrange for non-existent source files to
 be fetched from a source code management system
 using the specified
@@ -5826,6 +5853,10 @@ source_nodes = env.subst('$EXPAND_TO_NODELIST',
 '\"directory hierarchy in your
 '\"local build directory.
 '\"
+'\"This function is deprecated.  For details, see the entry for the
+'\".B SourceCode
+'\"function.
+'\"
 '\"Example:
 '\"
 '\".ES