[Boost-commit] svn:boost r81016 - trunk/tools/build/v2/doc/src

Subject: [Boost-commit] svn:boost r81016 - trunk/tools/build/v2/doc/src
From: steven_at_[hidden]
Date: 2012-10-19 13:30:04

Author: steven_watanabe
Date: 2012-10-19 13:30:02 EDT (Fri, 19 Oct 2012)
New Revision: 81016
URL: http://svn.boost.org/trac/boost/changeset/81016

Log:
Add documentation of --hash and --abbreviate-paths in the list of options.  Also add an index entry for Target Paths.  Refs #7533.
Text files modified: 
   trunk/tools/build/v2/doc/src/overview.xml  |    22 ++++++++++++++++++++++                  
   trunk/tools/build/v2/doc/src/path.xml      |     1 +                                       
   trunk/tools/build/v2/doc/src/reference.xml |     1 +                                       
   3 files changed, 24 insertions(+), 0 deletions(-)

Modified: trunk/tools/build/v2/doc/src/overview.xml
==============================================================================
--- trunk/tools/build/v2/doc/src/overview.xml	(original)
+++ trunk/tools/build/v2/doc/src/overview.xml	2012-10-19 13:30:02 EDT (Fri, 19 Oct 2012)
@@ -688,6 +688,28 @@
           </varlistentry>
 
           <varlistentry>
+            <term><option>--abbreviate-paths</option></term>
+            <listitem>
+              <para>Compresses target paths by abbreviating each component.
+              This option is useful to keep paths from becoming longer than
+              the filesystem supports.  See also <xref linkend="bbv2.reference.buildprocess.targetpath"/>.
+              </para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
+            <term><option>--hash</option></term>
+            <listitem>
+              <para>Compresses target paths using an MD5 hash.  This option is
+              useful to keep paths from becoming longer than the filesystem
+              supports.  This option produces shorter paths than --abbreviate-paths
+              does, but at the cost of making them less understandable.
+              See also <xref linkend="bbv2.reference.buildprocess.targetpath"/>.
+              </para>
+            </listitem>
+          </varlistentry>
+
+          <varlistentry>
             <term><option>--version</option></term>
             <listitem>
               <para>Prints information on the Boost.Build and Boost.Jam

Modified: trunk/tools/build/v2/doc/src/path.xml
==============================================================================
--- trunk/tools/build/v2/doc/src/path.xml	(original)
+++ trunk/tools/build/v2/doc/src/path.xml	2012-10-19 13:30:02 EDT (Fri, 19 Oct 2012)
@@ -7,6 +7,7 @@
   <title>path</title>
   <indexterm>
     <primary>path</primary>
+    <secondary>module</secondary>
   </indexterm>
 
   <para>

Modified: trunk/tools/build/v2/doc/src/reference.xml
==============================================================================
--- trunk/tools/build/v2/doc/src/reference.xml	(original)
+++ trunk/tools/build/v2/doc/src/reference.xml	2012-10-19 13:30:02 EDT (Fri, 19 Oct 2012)
@@ -2089,6 +2089,7 @@
     
     <section id="bbv2.reference.buildprocess.targetpath">
       <title>Target Paths</title>
+      <indexterm><primary>path</primary><secondary>for targets</secondary></indexterm>
 
       <para>Several factors determine the location of a concrete
       file target.  All files in a project are built under