From: stevenknight <stevenknight@fdb21ef1-2011-0410-befe-b5e4ea1792b1>
Date: Wed, 11 Jun 2003 13:01:05 +0000 (+0000)
Subject: Documentation fixes:  mention that user-defined *FLAGS options don't include the... 
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=027b4e6586abe42726181d94c234c13cd7300f08;p=scons.git

Documentation fixes:  mention that user-defined *FLAGS options don't include the generated sh*FLAGS (-I or -L) options.


git-svn-id: http://scons.tigris.org/svn/scons/trunk@709 fdb21ef1-2011-0410-befe-b5e4ea1792b1
---

diff --git a/doc/man/scons.1 b/doc/man/scons.1
index d2dd89bd..16d6a678 100644
--- a/doc/man/scons.1
+++ b/doc/man/scons.1
@@ -2195,7 +2195,7 @@ env['_CPPINCFLAGS'] = '$( ${_concat(INCPREFIX, CPPPATH, INCSUFFIX, __env__, RDir
 .EE
 
 .IP CPPFLAGS
-C preprocessor options.
+User-specified C preprocessor options.
 These will be included in any command that uses the C preprocessor,
 including not just compilation of C and C++ source files
 via the $CCCOM, $SHCCCOM, $CXXCOM and $SHCXXCOM command lines,
@@ -2204,6 +2204,16 @@ used to compile a Fortran source file,
 and the $ASPPCOM command line
 used to assemble an assembly language source file,
 after first running each file through the C preprocessor.
+Note that this variable does
+.I not
+contain
+.B -I
+(or similar) include search path options
+that scons generates automatically from $CPPPATH.
+See
+.BR _CPPINCFLAGS ,
+below,
+for the variable that expands to those options.
 
 .IP _CPPINCFLAGS
 An automatically-generated construction variable
@@ -2386,7 +2396,17 @@ The Fortran compiler.
 The command line used to compile a Fortran source file to an object file.
 
 .IP F77FLAGS
-General options that are passed to the Fortran compiler.
+General user-specified options that are passed to the Fortran compiler.
+Note that this variable does
+.I not
+contain
+.B -I
+(or similar) include search path options
+that scons generates automatically from $F77PATH.
+See
+.BR _F77INCFLAGS ,
+below,
+for the variable that expands to those options.
 
 .IP _F77INCFLAGS
 An automatically-generated construction variable
@@ -2625,7 +2645,8 @@ when the $_LIBFLAGS variable is automatically generated.
 The list of directories that will be searched for libraries.
 The implicit dependency scanner will search these
 directories for include files. Don't explicitly put include directory
-arguments in LINKFLAGS because the result will be non-portable
+arguments in $LINKFLAGS or $SHLINKFLAGS
+because the result will be non-portable
 and the directories will not be searched by the dependency scanner. Note:
 directory names in LIBPATH will be looked-up relative to the SConscript
 directory when they are used in a command. To force 
@@ -2706,7 +2727,24 @@ An array of legal suffixes for library file names.
 The linker.
 
 .IP LINKFLAGS
-General options passed to the linker.
+General user options passed to the linker.
+Note that this variable should
+.I not
+contain
+.B -l
+(or similar) options for linking with the libraries listed in $LIBS,
+nor
+.B -L
+(or similar) library search path options
+that scons generates automatically from $LIBPATH.
+See
+.BR _LIBFLAGS ,
+above,
+for the variable that expands to library-link options,
+and
+.BR _LIBDIRFLAGS ,
+above,
+for the variable that expands to library search path options.
 
 .IP LINKCOM
 The command line used to link object files into an executable.
@@ -2975,7 +3013,24 @@ The suffix used for shared library file names.
 The linker for programs that use shared libraries.
 
 .IP SHLINKFLAGS
-General options passed to the linker for programs using shared libraries.
+General user options passed to the linker for programs using shared libraries.
+Note that this variable should
+.I not
+contain
+.B -l
+(or similar) options for linking with the libraries listed in $LIBS,
+nor
+.B -L
+(or similar) include search path options
+that scons generates automatically from $LIBPATH.
+See
+.BR _LIBFLAGS ,
+above,
+for the variable that expands to library-link options,
+and
+.BR _LIBDIRFLAGS ,
+above,
+for the variable that expands to library search path options.
 
 .IP SHOBJPREFIX 
 The prefix used for shared object file names.
diff --git a/src/CHANGES.txt b/src/CHANGES.txt
index 5ea21d3e..53949851 100644
--- a/src/CHANGES.txt
+++ b/src/CHANGES.txt
@@ -34,7 +34,10 @@ RELEASE 0.15 - XXX
     must have the same form as valid Python identifiers.
 
   - Fix man page bugs: remove duplicate AddPostAction() description;
-    document no_import_lib.
+    document no_import_lib; mention that CPPFLAGS does not contain
+    $_CPPINCFLAGS; mention that F77FLAGS does not contain $_F77INCFLAGS;
+    mention that LINKFLAGS and SHLINKFLAGS contains neither $_LIBFLAGS
+    nor $_LIBDIRFLAGS.
 
   - Eliminate a dependency on the distutils.fancy_getopt module by
     copying and pasting its wrap_text() function directly.