diff options
Diffstat (limited to 'scons.1')
| -rw-r--r-- | scons.1 | 153 |
1 files changed, 32 insertions, 121 deletions
@@ -1,4 +1,4 @@ -.\" Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 The SCons Foundation +.\" Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 The SCons Foundation .\" .\" Permission is hereby granted, free of charge, to any person obtaining .\" a copy of this software and associated documentation files (the @@ -19,9 +19,9 @@ .\" OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION .\" WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. .\" -.\" doc/man/scons.1 4577 2009/12/27 19:43:56 scons +.\" doc/man/scons.1 4629 2010/01/17 22:23:21 scons .\" -.TH SCONS 1 "December 2009" +.TH SCONS 1 "January 2010" .\" ES - Example Start - indents and turns off line fill .rm ES .de ES @@ -73,7 +73,7 @@ The .I SConstruct file can specify subsidiary configuration files using the -.B SConscript() +.BR SConscript () function. By convention, these subsidiary files are named @@ -6542,17 +6542,24 @@ The '\" .I src_dir '\" arguments are interpreted relative to the directory of the calling argument is interpreted relative to the directory of the calling -.BR SConscript file. +.B SConscript +file. See the description of the .BR VariantDir () function below for additional details and restrictions. If -'\" .IR variant_dir " is present, but" +.I variant_dir +is present, +'\" but '\" .IR src_dir " is not," -.IR variant_dir " is present," -the source directory is relative to the called -.BR SConscript " file." +the source directory is the directory in which the +.B SConscript +file resides and the +.B SConscript +file is evaluated as if it were in the +.I variant_dir +directory: .ES SConscript('src/SConscript', variant_dir = 'build') .EE @@ -6563,7 +6570,7 @@ SConscript('build/SConscript') .EE This later paradigm is often used when the sources are in the same directory as the -.BR SConstruct file: +.BR SConstruct: .ES SConscript('SConscript', variant_dir = 'build') .EE @@ -9099,6 +9106,8 @@ when converting PostScript to PDF files. Sets the host architecture for Visual Studio compiler. If not set, default to the detected host architecture: note that this may depend on the python you are using. +This variable must be passed as an argument to the Environment() +constructor; setting it later has no effect. Valid values are the same as for $TARGET_ARCH. @@ -9727,12 +9736,12 @@ and .IP MSVC_BATCH When set to any true value, -specifies that &SCons; should batch +specifies that SCons should batch compilation of object files when calling the Microsoft Visual C/C++ compiler. All compilations of source files from the same source directory that generate target files in a same output directory -and were configured in &SCons; using the same construction environment +and were configured in SCons using the same construction environment will be built in a single call to the compiler. Only source files that have changed since their object files were built will be passed to each compiler invocation @@ -9745,11 +9754,12 @@ will be compiled separately. .IP MSVC_VERSION Sets the preferred version of Microsoft Visual C/C++ to use. -If $MSVC_VERSION is not set, -&SCons; will (by default) select the latest version -of Visual C/C++ installed on your system. -If the specified version isn't installed, -tool initialization will fail. +If $MSVC_VERSION is not set, SCons will (by default) select the +latest version of Visual C/C++ installed on your system. If the +specified version isn't installed, tool initialization will fail. +This variable must be passed as an argument to the Environment() +constructor; setting it later has no effect. Set it to an unexpected +value (e.g. "XXX") to see the valid values on your system. .IP MSVS When the Microsoft Visual Studio tools are initialized, they set up @@ -9801,34 +9811,6 @@ Trying to set $MSVS_ARCH to an architecture that's not supported for a given Visual Studio version will generate an error. -.IP MSVS_IGNORE_IDE_PATHS -Tells the MS Visual Studio tools to use minimal INCLUDE, LIB, and PATH settings, -instead of the settings from the IDE. - -For Visual Studio, SCons will (by default) automatically determine -where MSVS is installed, and use the LIB, INCLUDE, and PATH variables -set by the IDE. You can override this behavior by setting these -variables after Environment initialization, or by setting -.B MSVS_IGNORE_IDE_PATHS = 1 -in the Environment initialization. -Specifying this will not leave these unset, but will set them to a -minimal set of paths needed to run the tools successfully. - -For VS6, the mininimal set is: -.ES - INCLUDE:'<VSDir>\\VC98\\ATL\\include;<VSDir>\\VC98\\MFC\\include;<VSDir>\\VC98\\include' - LIB:'<VSDir>\\VC98\\MFC\\lib;<VSDir>\\VC98\\lib' - PATH:'<VSDir>\\Common\\MSDev98\\bin;<VSDir>\\VC98\\bin' -.EE -For VS7, it is: -.ES - INCLUDE:'<VSDir>\\Vc7\\atlmfc\\include;<VSDir>\\Vc7\\include' - LIB:'<VSDir>\\Vc7\\atlmfc\\lib;<VSDir>\\Vc7\\lib' - PATH:'<VSDir>\\Common7\\Tools\\bin;<VSDir>\\Common7\\Tools;<VSDir>\\Vc7\\bin' -.EE -.IP -Where '<VSDir>' is the installed location of Visual Studio. - .IP MSVS_PROJECT_BASE_PATH The string placed in a generated Microsoft Visual Studio solution file @@ -9904,81 +9886,6 @@ attribute of the section of the Microsoft Visual Studio solution file. There is no default value. -.IP MSVS_USE_MFC_DIRS -Tells the MS Visual Studio tool(s) to use -the MFC directories in its default paths -for compiling and linking. -The $MSVS_USE_MFC_DIRS variable has no effect if the -.B INCLUDE -or -.B LIB -environment variables are set explictly. - -Under Visual Studio version 6, -setting -$MSVS_USE_MFC_DIRS -to a non-zero value -adds the -.B "ATL\\\\ATL" -and -.B "MFC\\\\MFC" -directories to -the default -.B INCLUDE -external environment variable, -and adds the -.B "MFC\\\\MFC" -directory to -the default -.B LIB -external environment variable. - -Under Visual Studio version 7, -setting -$MSVS_USE_MFC_DIRS -to a non-zero value -adds the -.B "atlmfc\\\\atlmfc" -directory to the default -.B INCLUDE -external environment variable, -and adds the -.B "atlmfc\\\\atlmfc" -directory to the default -.B LIB -external environment variable. - -Under Visual Studio version 8, -setting -$MSVS_USE_MFC_DIRS -to a non-zero value will, -by default, -add the -.B "atlmfc\\\\atlmfc" -directory to the default -.B INCLUDE -external environment variable, -and the -.B "atlmfc\\\\atlmfc" -directory to the default -.B LIB -external environment variable. -If, however, the -.B ['MSVS']['PLATFORMSDKDIR'] -variable is set, -then the -.B mfc -and the -.B atl -subdirectories of the -.B PLATFORMSDKDIR -are added to the default value of the -.B INCLUDE -external environment variable, -and the default value of the -.B LIB -external environment variable is left untouched. - .IP MSVS_VERSION Sets the preferred version of Microsoft Visual Studio to use. @@ -11274,7 +11181,11 @@ that may not be set or used in a construction environment. .IP TARGET_ARCH Sets the target architecture for Visual Studio compiler (i.e. the arch of the binaries generated by the compiler). If not set, default to -$HOST_ARCH. +$HOST_ARCH, or, if that is unset, to the architecture of the +running machine's OS (note that the python build or architecture has no +effect). +This variable must be passed as an argument to the Environment() +constructor; setting it later has no effect. This is currently only used on Windows, but in the future it will be used on other OSes as well. |