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

Subject: [Boost-commit] svn:boost r49663 - trunk/tools/build/v2/doc/src
From: ghost_at_[hidden]
Date: 2008-11-09 10:03:15

Author: vladimir_prus
Date: 2008-11-09 10:03:15 EST (Sun, 09 Nov 2008)
New Revision: 49663
URL: http://svn.boost.org/trac/boost/changeset/49663

Log:
Document 'threading' feature
Text files modified: 
   trunk/tools/build/v2/doc/src/reference.xml |    27 ++++++++++++++++++++++++++-             
   1 files changed, 26 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	2008-11-09 10:03:15 EST (Sun, 09 Nov 2008)
@@ -238,6 +238,12 @@
   <section id="bbv2.advanced.builtins.features">
     <title>Builtin features</title>
 
+    <para>This section documents the features that are built-in into
+    Boost.Build. For features with a fixed set of values, that set is
+    provided, with the default value listed first.</para>
+
+    <indexterm><primary>features</primary><secondary>builtin</secondary></indexterm>
+
     <variablelist>
       <varlistentry><term><literal>variant</literal></term>
 
@@ -328,6 +334,25 @@
         </listitem>
       </varlistentry>
 
+      <varlistentry>
+        <term><literal>threading</literal></term>
+
+        <listitem>
+
+          <para><emphasis role="bold">Allowed values:</emphasis> <literal>single</literal>,
+            <literal>multi</literal></para>
+
+          <simpara>
+            Controls if the project should be built in multi-threaded mode.  This feature does not
+            necessary change code generation in the compiler, but it causes the compiler to link
+            to additional or different runtime libraries, and define additional preprocessor 
+            symbols (for example, <code>_MT</code> on Windows and <code>_REENTRANT</code> on Linux). 
+            How those symbols affect the compiled code depends on the code itself.
+          </simpara>
+
+        </listitem>
+      </varlistentry>
+
       <varlistentry><term><literal>source</literal></term>
 
         <listitem>
@@ -2077,7 +2102,7 @@
 
 <!--
      Local Variables:
-     mode: xml
+     mode: nxml
      sgml-indent-data: t
      sgml-parent-document: ("userman.xml" "chapter")
      sgml-set-face: t