Implement Tool refactoring. (Chad Austin + Steve Leblanc)

1 files changed, 18 insertions, 1 deletions

diff --git a/doc/man/scons.1 b/doc/man/scons.1
index 75e83d1..a3f35af 100644
--- a/doc/man/scons.1
+++ b/doc/man/scons.1
@@ -844,12 +844,15 @@ will call the specified elements
 to update the new construction environment:
 
 .ES
-def my_tool(env, platform):
+def my_tool(env):
     env['XYZZY'] = 'xyzzy'
 
 env = Environment(tools = [my_tool])
 .EE
 
+The tool definition (i.e. my_tool()) can use the PLATFORM variable from
+the environment it receives to customize the tool for different platforms.
+
 If no tool list is specified, then SCons will auto-detect the installed
 tools using the PATH variable in the ENV construction variable and the
 platform name when the Environment is constructed. Changing the PATH
@@ -2555,6 +2558,20 @@ The prefix used for PDF file names.
 .IP PDFSUFFIX
 The suffix used for PDF file names.
 
+.IP PLATFORM
+The name of the platform used to create the Environment.  If no platform is
+specified when the Environment is created,
+.B SCons
+autodetects the platform.
+
+.ES
+env = Environment(tools = [])
+if env['PLATFORM'] == 'cygwin':
+    Tool('mingw')(env)
+else:
+    Tool('msvc')(env)
+.EE
+
 .IP PROGPREFIX
 The prefix used for executable file names.