Add mention of LIBSUFFIXES in the SharedLibrary() example for overriding SHLIBSUFFIX.

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

diff --git a/doc/man/scons.1 b/doc/man/scons.1
index b5199be79bcfdca437504afa95e7081effedc9c5..b2fec5889a3715e0415dc8aac4374e0c7ec5cd4a 100644 (file)
--- a/doc/man/scons.1
+++ b/doc/man/scons.1
@@ -1352,12 +1352,19 @@ libraries for just one program:
 env.Program('hello', 'hello.c', LIBS=['gl', 'glut'])
 .EE
 
-or generate a shared library with a nonstandard suffix:
+or generate a shared library with a non-standard suffix:
 
 .ES
-env.SharedLibrary('word', 'word.cpp', SHLIBSUFFIX='.ocx')
+env.SharedLibrary('word', 'word.cpp',
+                  SHLIBSUFFIX='.ocx',
+                  LIBSUFFIXES=['.ocx'])
 .EE
 
+(Note that both the $SHLIBSUFFIX and $LIBSUFFIXES variables must be set
+if you want SCons to search automatically
+for dependencies on the non-standard library names;
+see the descriptions of these variables, below, for more information.)
+
 Although the builder methods defined by
 .B scons
 are, in fact,

diff --git a/src/CHANGES.txt b/src/CHANGES.txt
index 0833bf8539c6f69acfdb187fb14ac48304c11900..db48e3fd696535ff1f79238be4dadc2492e3cf58 100644 (file)
--- a/src/CHANGES.txt
+++ b/src/CHANGES.txt
@@ -405,6 +405,9 @@ RELEASE 0.97 - XXX
     be /usr/sbin/pgkchk (since /usr/sbin isn't usually on the external
     execution $PATH).
 
+  - Fix a man page example of overriding variables when calling
+    SharedLibrary() to also set the $LIBSUFFIXES variable.
+
   From Chen Lee:
 
   - Handle Visual Studio project and solution files in Unicode.

diff --git a/src/engine/SCons/Platform/__init__.xml b/src/engine/SCons/Platform/__init__.xml
index 0cdd62bdeb324792857972f7ad8d01368c19985b..a74df5a2bd5c45c6ed11f75efdf2209d3b5da6d3 100644 (file)
--- a/src/engine/SCons/Platform/__init__.xml
+++ b/src/engine/SCons/Platform/__init__.xml
@@ -25,7 +25,11 @@ to reflect the names of the libraries they create.
 
 <cvar name="LIBPREFIXES">
 <summary>
-An array of legal prefixes for library file names.
+A list of all legal prefixes for library file names.
+When searching for library dependencies,
+SCons will look for files with these prefixes,
+the base library name,
+and suffixes in the &cv-LIBSUFFIXES; list.
 </summary>
 </cvar>
 
@@ -42,7 +46,11 @@ to reflect the names of the libraries they create.
 
 <cvar name="LIBSUFFIXES">
 <summary>
-An array of legal suffixes for library file names.
+A list of all legal suffixes for library file names.
+When searching for library dependencies,
+SCons will look for files with prefixes, in the &cv-LIBPREFIXES; list,
+the base library name,
+and these suffixes.
 </summary>
 </cvar>