|
Boost-Build : |
From: Jurko Gospodnetiæ (jurko.gospodnetic_at_[hidden])
Date: 2007-12-22 23:05:26
[Forgot to attach the actual patch in the original message. :-)]
Hi.
Attached patch corrects an invalid example and does some minor
stylistic changes in the alias rule documentation.
Hope this helps.
Best regards,
Jurko Gospodnetiæ
--- X:\Boost_Build\\20071222_nightly_build\Original\boost-build\doc\src\tasks.xml 2007-12-21 15:33:44.000000000 +-0100
+++ X:\Boost_Build\\20071222_nightly_build\Modified\boost-build\doc\src\tasks.xml 2007-12-23 03:08:07.000000000 +-0100
@@ -189,52 +189,52 @@
</section>
<section id="bbv2.tasks.alias">
<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>
<para>
Another use of the <code>alias</code> rule is to change build
properties. For example, if you always want static linking for a
specific C++ Boost library, you can write the following:
<programlisting>
alias threads : /boost/thread//boost_thread : <link>static ;
</programlisting>
and use only the <code>threads</code> alias in your Jamfiles.
- <!-- changed name for clarity -->
</para>
<para>
You can also specify usage requirements for the
<code>alias</code> target. If you write the following:
<programlisting>
alias header_only_library : : : : <include>/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 : : : <include>. ;
-alias lib_alias ; <!-- This line can't possibly be correct!?? -->
-exe main : main.cpp lib_alias ;
+lib library1 : library1.cpp : : : <include>/library/include1 ;
+lib library2 : library2.cpp : : : <include>/library/include2 ;
+alias static_libraries : library1 library2 : <link>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>
<section id="bbv2.tasks.installing">
<title>Installing</title>
Boost-Build list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk