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

Subject: [Boost-commit] svn:boost r77715 - trunk/tools/build/v2/doc/src
From: steven_at_[hidden]
Date: 2012-04-02 11:16:21

Author: steven_watanabe
Date: 2012-04-02 11:16:19 EDT (Mon, 02 Apr 2012)
New Revision: 77715
URL: http://svn.boost.org/trac/boost/changeset/77715

Log:
Don't use functionname for jam.
Text files modified: 
   trunk/tools/build/v2/doc/src/extending.xml |     6 +++---                                  
   trunk/tools/build/v2/doc/src/overview.xml  |    17 +++++++++--------                       
   trunk/tools/build/v2/doc/src/reference.xml |     4 ++--                                    
   trunk/tools/build/v2/doc/src/tasks.xml     |    34 +++++++++++++++++-----------------      
   trunk/tools/build/v2/doc/src/tutorial.xml  |     6 +++---                                  
   5 files changed, 34 insertions(+), 33 deletions(-)

Modified: trunk/tools/build/v2/doc/src/extending.xml
==============================================================================
--- trunk/tools/build/v2/doc/src/extending.xml	(original)
+++ trunk/tools/build/v2/doc/src/extending.xml	2012-04-02 11:16:19 EDT (Mon, 02 Apr 2012)
@@ -393,7 +393,7 @@
 type.register VERBATIM : verbatim ;
 </programlisting>
 
-      <para>The first parameter to <functionname>type.register</functionname> gives
+      <para>The first parameter to <link linkend="bbv2.reference.modules.type.register">type.register</link> gives
       the name of the declared type. By convention, it's uppercase. The second
       parameter is the suffix for files of this type. So, if Boost.Build sees
       <filename>code.verbatim</filename> in a list of sources, it knows that it's of
@@ -1031,8 +1031,8 @@
   <section id="bbv2.extending.rules">
     <title>Main target rules</title>
     <para>
-      A main target rule (e.g “<functionname>exe</functionname>”
-      Or “<functionname>lib</functionname>”) creates a top-level target. It's quite likely that you'll want to declare your own and
+      A main target rule (e.g “<link linkend="bbv2.tasks.programs">exe</link>”
+      Or “<link linkend="bbv2.tasks.libraries">lib</link>”) creates a top-level target. It's quite likely that you'll want to declare your own and
       there are two ways to do that.
       <!-- Why did "that" get changed to "this" above? -->
     </para>

Modified: trunk/tools/build/v2/doc/src/overview.xml
==============================================================================
--- trunk/tools/build/v2/doc/src/overview.xml	(original)
+++ trunk/tools/build/v2/doc/src/overview.xml	2012-04-02 11:16:19 EDT (Mon, 02 Apr 2012)
@@ -462,7 +462,7 @@
 using <replaceable>tool-name</replaceable> : ... ;
 </programlisting>
 <para>
-      The <functionname>using</functionname> rule is given the name of tool, and
+      The <code language="jam">using</code> rule is given the name of tool, and
       will make that tool available to Boost.Build. For example,
 <programlisting>
 using gcc ;
@@ -478,7 +478,7 @@
     <para>
       For all the C++ compiler toolsets that Boost.Build supports
       out-of-the-box, the list of parameters to
-      <functionname>using</functionname> is the same: <parameter
+      <code language="jam">using</code> is the same: <parameter
       class="function">toolset-name</parameter>, <parameter
       class="function">version</parameter>, <parameter
       class="function">invocation-command</parameter>, and <parameter
@@ -521,13 +521,13 @@
 
     <para>
       To configure several versions of a toolset, simply invoke the
-      <functionname>using</functionname> rule multiple times:
+      <code language="jam">using</code> rule multiple times:
 <programlisting>
 using gcc : 3.3 ;
 using gcc : 3.4 : g++-3.4 ;
 using gcc : 3.2 : g++-3.2 ;
 </programlisting>
-      Note that in the first call to <functionname>using</functionname>, the
+      Note that in the first call to <code language="jam">using</code>, the
       compiler found in the <envar>PATH</envar> will be used, and there is no
       need to explicitly specify the command.
     </para>
@@ -1109,7 +1109,8 @@
         files. Sometimes, you'll want to automatically construct the
         list of source files rather than having to spell it out
         manually, in which case you can use the
-        <functionname>glob</functionname> rule. Here are two examples:</para>
+        <link linkend="bbv2.reference.rules.glob">glob</link> rule.
+        Here are two examples:</para>
 <programlisting>
 exe a : a.cpp ;           # a.cpp is the only source file
 exe b : [ glob *.cpp ] ;  # all .cpp files in this directory are sources
@@ -1306,7 +1307,7 @@
          <para>When no target is requested on the command line, all targets in the
          current project will be built. If a target should be built only by
          explicit request, this can be expressed by the
-         <functionname>explicit</functionname> rule:
+         <link linkend="bbv2.reference.rules.explicit">explicit</link> rule:
          <programlisting>
 explicit install_programs ;</programlisting>
          </para>
@@ -1326,7 +1327,7 @@
       </para>
 
       <para>Projects are named using the
-      <functionname>project</functionname> rule, which has the
+      <code language="jam">project</code> rule, which has the
       following syntax:
 <programlisting>
 project <replaceable>id</replaceable> : <replaceable>attributes</replaceable> ;
@@ -1389,7 +1390,7 @@
 
                 <entry>Default value</entry>
 
-                <entry>Handling by the <functionname>project</functionname>
+                <entry>Handling by the <code language="jam">project</code>
                 rule</entry>
 
               </row>

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	2012-04-02 11:16:19 EDT (Mon, 02 Apr 2012)
@@ -126,7 +126,7 @@
         <link linkend="bbv2.main-target-rule-syntax">common syntax</link>.</para></listitem>
       </varlistentry>
 
-      <varlistentry>
+      <varlistentry id="bbv2.reference.rules.glob">
         <term><literal>glob</literal></term>
 
         <listitem><para>The <code>glob</code> rule takes a list shell pattern
@@ -178,7 +178,7 @@
         </para></listitem>
       </varlistentry>
 
-      <varlistentry>
+      <varlistentry id="bbv2.reference.rules.explicit">
         <term><literal>explicit</literal></term>
 
         <listitem><para>The <literal>explicit</literal> rule takes a single

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	2012-04-02 11:16:19 EDT (Mon, 02 Apr 2012)
@@ -211,7 +211,7 @@
     <title>Alias</title>
 
     <para>
-      The <functionname>alias</functionname> rule gives an alternative name to a
+      The <code language="jam">alias</code> 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>
@@ -392,8 +392,8 @@
     </para>
 
     <para>
-      The <functionname>unit-test</functionname> rule behaves like the
-      <functionname>exe</functionname> rule, but after the executable is created
+      The <code language="jam">unit-test</code> rule behaves like the
+      <link linkend="bbv2.tasks.programs">exe</link> rule, but after the executable is created
       it is also run. If the executable returns an error code, the build system
       will also return an error and will try running the executable on the next
       invocation until it runs successfully. This behaviour ensures that you can
@@ -506,22 +506,22 @@
     <para>
       <!-- This paragraph requires links to where the terms 'virtual target' &
       'target' are defined. -->
-      Three main target rules can be used for that. The <functionname>make
-      </functionname> rule allows you to construct a single file from any number
-      of source file, by running a command you specify. The <functionname>
-      notfile</functionname> rule allows you to run an arbitrary command,
-      without creating any files. And finaly, the <functionname>generate
-      </functionname> rule allows you to describe a transformation using
+      Three main target rules can be used for that. The <code language="jam">make
+      </code> rule allows you to construct a single file from any number
+      of source file, by running a command you specify. The <code language="jam">
+      notfile</code> rule allows you to run an arbitrary command,
+      without creating any files. And finaly, the <code language="jam">generate
+      </code> rule allows you to describe a transformation using
       Boost.Build's virtual targets. This is higher-level than the file names that
-      the <functionname>make</functionname> rule operates with and allows you to
+      the <code language="jam">make</code> rule operates with and allows you to
       create more than one target, create differently named targets depending on
       properties or use more than one tool.
     </para>
 
     <para>
-      The <functionname>make</functionname> rule is used when you want to create
+      The <code language="jam">make</code> rule is used when you want to create
       one file from a number of sources using some specific command. The
-      <functionname>notfile</functionname> is used to unconditionally run a
+      <code language="jam">notfile</code> is used to unconditionally run a
       command.
     </para>
 
@@ -551,7 +551,7 @@
     <para>
       It could be that you just want to run some command unconditionally, and
       that command does not create any specific files. For that you can use the
-      <functionname>notfile</functionname> rule. For example:
+      <code language="jam">notfile</code> rule. For example:
 <programlisting>
 notfile echo_something : @echo ;
 actions echo
@@ -559,7 +559,7 @@
     echo "something"
 }
 </programlisting>
-      The only difference from the <functionname>make</functionname> rule is
+      The only difference from the <code language="jam">make</code> rule is
       that the name of the target is not considered a name of a file, so
       Boost.Build will unconditionally run the action.
     </para>
@@ -567,9 +567,9 @@
     <para>
       <!-- This paragraph requires links to where terms like 'virtual target',
       'target', 'project-target' & 'property-set' are defined. -->
-      The <functionname>generate</functionname> rule is used when you want to
+      The <code language="jam">generate</code> rule is used when you want to
       express transformations using Boost.Build's virtual targets, as opposed to
-      just filenames. The <functionname>generate</functionname> rule has the
+      just filenames. The <code language="jam">generate</code> rule has the
       standard main target rule signature, but you are required to specify the
       <literal>generating-rule</literal> property. The value of the property
       should be in the form <literal>
@@ -628,7 +628,7 @@
 cpp-pch pch : pch.hpp ;
 exe main : main.cpp pch ;
 </programlisting>
-          You can use the <functionname>c-pch</functionname> rule if you want to
+          You can use the <code language="jam">c-pch</code> rule if you want to
           use the precompiled header in C programs.
         </para></listitem>
     </orderedlist>

Modified: trunk/tools/build/v2/doc/src/tutorial.xml
==============================================================================
--- trunk/tools/build/v2/doc/src/tutorial.xml	(original)
+++ trunk/tools/build/v2/doc/src/tutorial.xml	2012-04-02 11:16:19 EDT (Mon, 02 Apr 2012)
@@ -498,9 +498,9 @@
 exe e1 : e1.cpp foo ;
 exe e10 : e10.cpp foo ;</programlisting>
 
-      The <link linkend="bbv2.tasks.alias"><functionname>alias</functionname>
-      </link> rule is specifically used to rename a reference to a target and
-      possibly change the properties.
+      The <link linkend="bbv2.tasks.alias">alias</link> rule is specifically
+      used to rename a reference to a target and possibly change the
+      properties.
 
       <!-- You should introduce the alias rule in an earlier section, before
            describing how it applies to this specific use-case, and the