From 96bb7cb87b1291752513ec45d426a414b20d68bb Mon Sep 17 00:00:00 2001
From: Gary Oberbrunner <garyo@oberbrunner.com>
Date: Thu, 3 Jun 2010 01:40:26 +0000
Subject: Document GetBuildPath in Users Guide

---
 doc/scons.mod      |  2 ++
 doc/user/nodes.in  | 45 +++++++++++++++++++++++++++++++++++++++++++++
 doc/user/nodes.xml | 45 +++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 92 insertions(+)

(limited to 'doc')

diff --git a/doc/scons.mod b/doc/scons.mod
index f8d1fe05..1de28070 100644
--- a/doc/scons.mod
+++ b/doc/scons.mod
@@ -191,10 +191,12 @@
 <!ENTITY File "<function>File</function>">
 <!ENTITY FindFile "<function>FindFile</function>">
 <!ENTITY FindInstalledFiles "<function>FindInstalledFiles</function>">
+<!ENTITY FindPathDirs "<function>FindPathDirs</function>">
 <!ENTITY Finish "<function>Finish</function>">
 <!ENTITY Flatten "<function>Flatten</function>">
 <!ENTITY GenerateHelpText "<function>GenerateHelpText</function>">
 <!ENTITY GetBuildFailures "<function>GetBuildFailures</function>">
+<!ENTITY GetBuildPath "<function>GetBuildPath</function>">
 <!ENTITY GetLaunchDir "<function>GetLaunchDir</function>">
 <!ENTITY GetOption "<function>GetOption</function>">
 <!ENTITY Glob "<function>Glob</function>">
diff --git a/doc/user/nodes.in b/doc/user/nodes.in
index d8169df4..fb5ce23f 100644
--- a/doc/user/nodes.in
+++ b/doc/user/nodes.in
@@ -332,6 +332,51 @@
 
   </section>
 
+  <section>
+  <title>&GetBuildPath;: Getting the Path From a &Node; or String</title>
+
+    <para>
+
+    <function>env.GetBuildPath(file_or_list)</function>
+    returns the path of a &Node; or a string representing a
+    path.  It can also take a list of &Node;s and/or strings, and
+    returns the list of paths.  If passed a single &Node;, the result
+    is the same as calling <literal>str(node)</literal> (see above).
+    The string(s) can have embedded construction variables, which are
+    expanded as usual, using the calling environment's set of
+    variables.  The paths can be files or directories, and do not have
+    to exist.
+
+    </para>
+
+    <scons_example name="GetBuildPath">
+      <file name="SConstruct" printme="1">
+      env=Environment(VAR="value")
+      n=File("foo.c")
+      print env.GetBuildPath([n, "sub/dir/$VAR"])
+      </file>
+    </scons_example>
+
+    <para>
+
+    Would print the following file names:
+
+    </para>
+
+    <scons_output example="GetBuildPath" os="posix">
+      <scons_output_command>scons -Q</scons_output_command>
+    </scons_output>
+
+    <para>
+
+    There is also a function version of &GetBuildPath; which can
+    be called without an &Environment;; that uses the default SCons
+    &Environment; to do substitution on any string arguments.
+
+    </para>
+
+  </section>
+
   <!--
 
   <section>
diff --git a/doc/user/nodes.xml b/doc/user/nodes.xml
index 8f3436a4..e27d8942 100644
--- a/doc/user/nodes.xml
+++ b/doc/user/nodes.xml
@@ -335,6 +335,51 @@
 
   </section>
 
+  <section>
+  <title>&GetBuildPath;: Getting the Path From a &Node; or String</title>
+
+    <para>
+
+    <function>env.GetBuildPath(file_or_list)</function>
+    returns the path of a &Node; or a string representing a
+    path.  It can also take a list of &Node;s and/or strings, and
+    returns the list of paths.  If passed a single &Node;, the result
+    is the same as calling <literal>str(node)</literal> (see above).
+    The string(s) can have embedded construction variables, which are
+    expanded as usual, using the calling environment's set of
+    variables.  The paths can be files or directories, and do not have
+    to exist.
+
+    </para>
+
+    <programlisting>
+      env=Environment(VAR="value")
+      n=File("foo.c")
+      print env.GetBuildPath([n, "sub/dir/$VAR"])
+    </programlisting>
+
+    <para>
+
+    Would print the following file names:
+
+    </para>
+
+    <screen>
+      % <userinput>scons -Q</userinput>
+      ['foo.c', 'sub/dir/value']
+      scons: `.' is up to date.
+    </screen>
+
+    <para>
+
+    There is also a function version of &GetBuildPath; which can
+    be called without an &Environment;; that uses the default SCons
+    &Environment; to do substitution on any string arguments.
+
+    </para>
+
+  </section>
+
   <!--
 
   <section>
-- 
cgit v1.2.1