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

From: ghost_at_[hidden]
Date: 2007-12-25 04:34:38

Author: vladimir_prus
Date: 2007-12-25 04:34:38 EST (Tue, 25 Dec 2007)
New Revision: 42298
URL: http://svn.boost.org/trac/boost/changeset/42298

Log:
Correct an invalid alias example. Minor stylistic changes
changes in the alias rule documentation.

Patch from Jurko Gospodnetic.

Text files modified: 
   trunk/tools/build/v2/doc/src/tasks.xml |    22 +++++++++++-----------                  
   1 files changed, 11 insertions(+), 11 deletions(-)

Modified: trunk/tools/build/v2/doc/src/tasks.xml
==============================================================================
--- trunk/tools/build/v2/doc/src/tasks.xml	(original)
+++ trunk/tools/build/v2/doc/src/tasks.xml	2007-12-25 04:34:38 EST (Tue, 25 Dec 2007)
@@ -192,17 +192,16 @@
       <title>Alias</title>
 
       <para>
-        The <functionname>alias</functionname> rule gives alternative name to
+        The <functionname>alias</functionname> rule gives an alternative name to
         a group of targets. For example, to give the name
         <filename>core</filename> to a group of three other targets with the
         following code:
         <programlisting>
 alias core : im reader writer ;</programlisting>
-        Using <filename>core</filename> on the command line, or in the source list
-        of any other target is the same as explicitly using
+        Using <filename>core</filename> on the command line, or in the source
+        list of any other target is the same as explicitly using
         <filename>im</filename>, <filename>reader</filename>, and
         <filename>writer</filename>, but it is just more convenient.
-
       </para>
 
 
@@ -214,7 +213,6 @@
 alias threads : /boost/thread//boost_thread : &lt;link&gt;static ;
 </programlisting>
         and use only the <code>threads</code> alias in your Jamfiles.
-        <!-- changed name for clarity -->
       </para>              
 
       <para>
@@ -224,14 +222,16 @@
 alias header_only_library : : : :  &lt;include&gt;/usr/include/header_only_library ; 
 </programlisting>
         then using <code>header_only_library</code> in sources will only add an
-        include path. Also note that when there are some sources, their usage
-        requirements are propagated, too. For example:
+        include path. Also note that when an alias has sources, their usage
+        requirements are propagated as well. For example:
 <programlisting>
-lib lib : lib.cpp : : : &lt;include&gt;. ;
-alias lib_alias ; <!-- This line can't possibly be correct!?? -->
-exe main : main.cpp lib_alias ;
+lib library1 : library1.cpp : : : &lt;include&gt;/library/include1 ;
+lib library2 : library2.cpp : : : &lt;include&gt;/library/include2 ;
+alias static_libraries : library1 library2 : &lt;link&gt;static ;
+exe main : main.cpp static_libraries ;
 </programlisting>
-        will compile <filename>main.cpp</filename> with the additional include.
+        will compile <filename>main.cpp</filename> with additional includes
+        required for using the specified static libraries.
       </para>
  
     </section>