Update of /cvsroot/boost/boost/tools/build/v2/doc/src
In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv2577

Modified Files:
        tasks.xml 
Log Message:
Corrections to PCH docs from Charles Brockman.
Documentation for the debug-symbols feature.

Index: tasks.xml
===================================================================
RCS file: /cvsroot/boost/boost/tools/build/v2/doc/src/tasks.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- tasks.xml   6 Nov 2006 01:44:10 -0000       1.4
+++ tasks.xml   8 Nov 2006 06:16:24 -0000       1.5
@@ -463,7 +463,7 @@
     </section>
 
     <section id="bbv2.reference.precompiled_headers">
-      <title>Precompiled headers</title>
+      <title>Precompiled Headers</title>
 
       <para>Precompiled headers is a mechanism to speed up compilation
       by creating a partially processed version of some header files,
@@ -481,8 +481,8 @@
         when PCH is not enabled. Include the new header at the top of your
         source files.</para></listitem>
 
-        <listitem><para>Declare new Boost.Build target for the precompiled 
header
-        and add that precompiled header to sources of the target whose 
compilation
+        <listitem><para>Declare a new Boost.Build target for the precompiled 
header
+        and add that precompiled header to the sources of the target whose 
compilation
         you want to speed up:
         <programlisting>
 cpp-pch pch : header.hpp ;
@@ -501,14 +501,14 @@
         first thing in a source file, before any code or preprocessor 
directives.
         </para></listitem>
 
-        <listitem><para>The build properties used to build the sources and the
-        preprocessed must be the same. Consider using project requirements to 
-        assure this.
+        <listitem><para>The build properties used to compile the source files 
+        and  the precompiled header must be the same. Consider using 
+        project requirements to assure this.
         </para></listitem>
 
         <listitem><para>Precompiled headers must be used purely as a way to
-        improve compilation time, not to save the number of include statements.
-        If a source file needs to include some header, explicitly include
+        improve compilation time, not to save the number of 
<code>#include</code>
+        statements. If a source file needs to include some header, explicitly 
include
         it in the source file, even if the same header is included from
         the precompiled header. This makes sure that your project will build
         even if precompiled headers are not supported.</para></listitem>
@@ -805,6 +805,21 @@
 
       </varlistentry>
 
+      <varlistentry><term><literal>debug-symbols</literal></term>
+        
+        <listitem>        
+          <para><emphasis role="bold">Allowed values:</emphasis> 
<literal>on</literal>, <literal>off</literal>.</para>
+
+          <para>The <literal>debug-symbols</literal> feature specifies if
+          produced object files, executables and libraries should include 
+          debug information.
+          Typically, the value of this feature is implicitly set by the
+          <literal>variant</literal> feature, but it can be explicitly
+          specified by the user. The most common usage is to build
+          release variant with debugging information.</para>
+        </listitem>
+      </varlistentry>
+      
 
 
     </variablelist>


-------------------------------------------------------------------------
Using Tomcat but need to do more? Need to support web services, security?
Get stuff done quickly with pre-integrated technology to make your job easier
Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642
_______________________________________________
Boost-cvs mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/boost-cvs

Reply via email to