From: stevenknight <stevenknight@fdb21ef1-2011-0410-befe-b5e4ea1792b1>
Date: Sun, 10 Feb 2002 16:37:58 +0000 (+0000)
Subject: Document the LIBPATH construction variable.
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=71bf7ce1e6c4ef7817506e1dedf80d72436fa66a;p=scons.git

Document the LIBPATH construction variable.


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

diff --git a/doc/man/scons.1 b/doc/man/scons.1
index 7595724a..a50d7b5a 100644
--- a/doc/man/scons.1
+++ b/doc/man/scons.1
@@ -844,6 +844,31 @@ The prefix used to specify a library to link on the linker command line.
 .IP LIBLINKSUFFIX
 The suffix used to specify a library to link on the linker command line.
 
+.IP LIBPATH
+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
+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 
+.B scons
+to look-up a directory relative to the root of the source tree use #:
+
+.ES
+env = Environment(LIBPATH='#/libs')
+.EE
+
+.IP
+The directory look-up can also be forced using the 
+.BR Dir ()
+function:
+
+.ES
+libs = Dir('libs')
+env = Environment(LIBPATH=libs)
+.EE
+
 .IP LIBPREFIX
 The prefix used for library file names.
 
diff --git a/src/CHANGES.txt b/src/CHANGES.txt
index e77074ad..ae2f4877 100644
--- a/src/CHANGES.txt
+++ b/src/CHANGES.txt
@@ -53,6 +53,9 @@ RELEASE 0.05 -
   - Allow the list of variables exported to an SConscript file to be
     a UserList, too.
 
+  - Document the overlooked LIBPATH construction variable.
+    (Bug reported by Eicke Godehardt.)
+
   From Anthony Roach:
 
   - Make the scons script return an error code on failures.