summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorSteven Knight <knight@baldmt.com>2008-12-11 05:37:35 (GMT)
committerSteven Knight <knight@baldmt.com>2008-12-11 05:37:35 (GMT)
commitdc9330eb6885bf75b25953ec9b9bcef78054eab4 (patch)
treebd97fc1cfe788c0328ac7b83b415b94de5aa52e8 /doc
parenta7565584cb59a3bd03d82b27c817ad64ae364922 (diff)
downloadSCons-dc9330eb6885bf75b25953ec9b9bcef78054eab4.zip
SCons-dc9330eb6885bf75b25953ec9b9bcef78054eab4.tar.gz
SCons-dc9330eb6885bf75b25953ec9b9bcef78054eab4.tar.bz2
Issue 2231: Add a --warn=future-deprecated option, along with
FutureDeprecatedWarning and MandatoryDeprecatedWarning subclasses. Use these to future-deprecate the Taskmaster.Task class, which we intend to turn into an abstract base class by requiring subclasses to implement the .needs_execute() method.
Diffstat (limited to 'doc')
-rw-r--r--doc/man/scons.122
1 files changed, 21 insertions, 1 deletions
diff --git a/doc/man/scons.1 b/doc/man/scons.1
index 123ca5c..300e14c 100644
--- a/doc/man/scons.1
+++ b/doc/man/scons.1
@@ -1352,8 +1352,16 @@ These warnings are disabled by default.
.TP
--warn=deprecated, --warn=no-deprecated
-Enables or disables all warnings about use of deprecated features.
+Enables or disables all warnings about use of
+currently deprecated features.
These warnings are enabled by default.
+Note that the
+.b --warn=no-deprecated
+option does not disable warnings about absolutely all deprecated features.
+Warnings for some deprecated features that have already been through
+several releases with deprecation warnings
+may be mandatory for a release or two
+before they are officially no longer supported by SCons.
Warnings for some specific deprecated features
may be enabled or disabled individually;
see below.
@@ -1396,6 +1404,18 @@ Fortran and C++ object files in a single executable,
which can yield unpredictable behavior with some compilers.
.TP
+--warn=future-deprecated, --warn=no-future-deprecated
+Enables or disables warnings about features
+that will be deprecated in the future.
+These warnings are disabled by default.
+Enabling this warning is especially
+recommended for projects that redistribute
+SCons configurations for other users to build,
+so that the project can be warned as soon as possible
+about to-be-deprecated features
+that may require changes to the configuration.
+
+.TP
--warn=link, --warn=no-link
Enables or disables warnings about link steps.