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

Subject: [Boost-commit] svn:boost r83699 - trunk/tools/build/v2/doc/src
From: steven_at_[hidden]
Date: 2013-04-01 17:51:10

Author: steven_watanabe
Date: 2013-04-01 17:51:09 EDT (Mon, 01 Apr 2013)
New Revision: 83699
URL: http://svn.boost.org/trac/boost/changeset/83699

Log:
Document the new zlib module.
Text files modified: 
   trunk/tools/build/v2/doc/src/reference.xml |    79 +++++++++++++++++++++++++++++++++++++++ 
   1 files changed, 78 insertions(+), 1 deletions(-)

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	2013-04-01 17:51:09 EDT (Mon, 01 Apr 2013)
@@ -615,7 +615,7 @@
         </listitem>
       </varlistentry>
 
-      <varlistentry><term><literal>tag</literal></term>
+      <varlistentry><term><anchor id="bbv2.builtin.features.tag"/><literal>tag</literal></term>
 
         <listitem><para>The <literal>tag</literal> feature is used to customize
         the name of the generated files. The value should have the form:
@@ -1463,6 +1463,83 @@
 
         </section>
 
+        <section id="bbv2.reference.tools.libraries.zlib">
+          <title>zlib</title>
+          <indexterm><primary>zlib</primary></indexterm>
+
+          <para>Provides support for the
+          <ulink url="http://www.zlib.net">zlib</ulink> library.  zlib
+          can be configured either to use precompiled binaries or to
+          build the library from source.</para>
+
+          <para>zlib can be initialized using the following syntax</para>
+          <programlisting>
+using zlib : <optional><replaceable>version</replaceable></optional> : <optional><replaceable>options</replaceable></optional> : <optional><replaceable>condition</replaceable></optional> : <optional><replaceable>is-default</replaceable></optional> ;
+          </programlisting>
+          <para>Options for using a prebuilt library:</para>
+          <variablelist>
+            <varlistentry>
+              <term><literal>search</literal></term>
+              <listitem>
+                <para>The directory containing the zlib binaries.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><literal>name</literal></term>
+              <listitem>
+                <para>Overrides the default library name.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><literal>include</literal></term>
+              <listitem>
+                <para>The directory containing the zlib headers.</para>
+              </listitem>
+            </varlistentry>
+          </variablelist>
+          <para>If none of these options is specified, then the environmental
+          variables ZLIB_LIBRARY_PATH, ZLIB_NAME, and ZLIB_INCLUDE will be
+          used instead.</para>
+          <para>Options for building zlib from source:</para>
+          <variablelist>
+            <varlistentry>
+              <term><literal>source</literal></term>
+              <listitem>
+                <para>The zlib source directory.  Defaults to the
+                environmental variable ZLIB_SOURCE.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><literal>tag</literal></term>
+              <listitem>
+                <para>Sets the <link linkend="bbv2.builtin.features.tag">tag</link>
+                property to adjust the file name of the library.  Ignored
+                when using precompiled binaries.</para>
+              </listitem>
+            </varlistentry>
+            <varlistentry>
+              <term><literal>build-name</literal></term>
+              <listitem>
+                <para>The base name to use for the compiled library.
+                Ignored when using precompiled binaries.</para>
+              </listitem>
+            </varlistentry>
+          </variablelist>
+          <para>Examples:</para>
+          <programlisting>
+# Find zlib in the default system location
+using zlib ;
+# Build zlib from source
+using zlib : 1.2.7 : &lt;source&gt;/home/steven/zlib-1.2.7 ;
+# Find zlib in /usr/local
+using zlib : 1.2.7 : &lt;include&gt;/usr/local/include &lt;search&gt;/usr/local/lib ;
+# Build zlib from source for msvc and find
+# prebuilt binaries for gcc.
+using zlib : 1.2.7 : &lt;source&gt;C:/Devel/src/zlib-1.2.7 : &lt;toolset&gt;msvc ;
+using zlib : 1.2.7 : : &lt;toolset&gt;gcc ;
+</programlisting>
+        </section>
+
       </section>
 
       <section>