Changeset 1670 for trunk/doc


Ignore:
Timestamp:
Jan 14, 2003, 8:48:28 PM (16 years ago)
Author:
landonf
Message:

Update documentation to reflect changes to the build.target.* and related options

Location:
trunk/doc/guide/xml
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/guide/xml/commands.xml

    r1102 r1670  
    3232            <synopsis>Type: optional Default: make</synopsis>
    3333
    34             <para>Type of make required, either 'gnu' or 'bsd'. Sets build.cmd to either 'gnumake' or 'bsdmake' accordingly.</para>
    35 
    36             <para>
    37               <userinput>build.type gnu</userinput>
     34            <para>Defines which 'make' is required, either 'gnu' or 'bsd' Sets build.cmd to either 'gnumake' or 'bsdmake' accordingly</para>
     35
     36            <para>
     37              <userinput>build.type bsd</userinput>
    3838            </para>
    3939          </listitem>
     
    4444
    4545          <listitem>
    46             <synopsis>Type: read-only Default: ${build.target.current}</synopsis>
     46            <synopsis>Type: read-only Default: ${build.target}</synopsis>
    4747
    4848            <para>Arguments to pass to ${build.cmd} before ${build.args}.</para>
     
    6565
    6666        <varlistentry>
    67           <term>build.target.all</term>
     67          <term>build.target</term>
    6868
    6969          <listitem>
     
    7373
    7474            <para>
    75               <userinput>build.target.all all-src</userinput>
    76             </para>
    77           </listitem>
    78         </varlistentry>
    79 
    80         <varlistentry>
    81           <term>build.target.install</term>
     75              <userinput>build.target all-src</userinput>
     76            </para>
     77          </listitem>
     78        </varlistentry>
     79      </variablelist>
     80    </sect2>
     81
     82    <sect2>
     83      <title>Install Options</title>
     84
     85      <variablelist>
     86        <varlistentry>
     87          <term>install.cmd</term>
     88
     89          <listitem>
     90            <synopsis>cmdType: optional, Default: &dollar;&lcub;build.cmd&rcub;</synopsis>
     91
     92            <para>Install command to run relative to ${worksrcdir}.</para>
     93
     94            <para>
     95              <userinput>install.cmd pbxbuild</userinput>
     96            </para>
     97          </listitem>
     98        </varlistentry>
     99
     100        <varlistentry>
     101          <term>install.type</term>
     102
     103          <listitem>
     104            <synopsis>Type: optional Default: &dollar;&lcub;build.type&rcub;</synopsis>
     105
     106            <para>Defines which 'make' is required, either 'gnu' or 'bsd' Sets build.cmd to either 'gnumake' or 'bsdmake' accordingly</para>
     107
     108            <para>
     109              <userinput>install.type gnu</userinput>
     110            </para>
     111          </listitem>
     112        </varlistentry>
     113
     114        <varlistentry>
     115          <term>install.pre_args</term>
     116
     117          <listitem>
     118            <synopsis>Type: read-only Default: ${install.target}</synopsis>
     119
     120            <para>Arguments to pass to ${install.cmd} before ${install.args}.</para>
     121          </listitem>
     122        </varlistentry>
     123
     124        <varlistentry>
     125          <term>install.args</term>
     126
     127          <listitem>
     128            <synopsis>Type: optional</synopsis>
     129
     130            <para>Arguments to pass to ${install.cmd}.</para>
     131
     132            <para>
     133              <userinput>build.args -DNOWARN</userinput>
     134            </para>
     135          </listitem>
     136        </varlistentry>
     137
     138        <varlistentry>
     139          <term>install.target</term>
    82140
    83141          <listitem>
    84142            <synopsis>Type: optional Default: install</synopsis>
    85143
    86             <para>Install target to pass to ${build.cmd}.</para>
    87 
    88             <para>
    89               <userinput>build.target.install install-src</userinput>
    90             </para>
    91           </listitem>
    92         </varlistentry>
     144            <para>Install target to pass to ${install.cmd}.</para>
     145
     146            <para>
     147              <userinput>install.target install-src</userinput>
     148            </para>
     149          </listitem>
     150        </varlistentry>
     151
    93152      </variablelist>
    94153    </sect2>
  • trunk/doc/guide/xml/details.xml

    r1529 r1670  
    474474                                <term>build.type</term>
    475475                                <listitem>
    476                                         <para>Type of make required, either 'gnu' or 'bsd' Sets build.cmd to either
    477          'gnumake' or 'bsdmake' accordingly</para>
     476                                        <para>Defines which 'make' is required, either 'gnu' or 'bsd' Sets build.cmd to either
     477                                                'gnumake' or 'bsdmake' accordingly</para>
    478478                                        <para><userinput>build.type     gnu</userinput>
    479479                                        </para>
     
    498498                        </varlistentry>
    499499                       
    500                         <varlistentry id='build.target.all'>
     500                        <varlistentry id='build.target'>
    501501                                <term>build.target.all</term>
    502502                                <listitem>
     
    511511        <sect1>
    512512                <title>Install Phase</title>
    513                 <para></para>
    514513               
    515514                <variablelist>
    516                         <varlistentry id='build.target.install'>
    517                                         <term>build.target.install</term>
    518                                         <listitem>
    519                                                 <para>Install target to pass to &dollar;&lcub;build.cmd&rcub;. Defaults to all.</para>
    520                                                 <para><userinput>build.target.install     install-src</userinput>
    521                                                 </para>
    522                                         </listitem>
    523                                 </varlistentry>
    524                        
    525                 </variablelist>
     515
     516                        <varlistentry id='install.cmd'>
     517                                <term>install.cmd</term>
     518                                <listitem>
     519                                        <para>Install command to run relative to &dollar;&lcub;worksrcdir&rcub;. Defaults to &dollar;&lcub;build.cmd&rcub;.</para>
     520                                        <para><userinput>install.cmd pbxbuild</userinput>
     521                                        </para>
     522                                </listitem>
     523                        </varlistentry>
     524                       
     525                        <varlistentry id='install.type'>
     526                                <term>install.type</term>
     527                                <listitem>
     528                                        <para>Defines which 'make' is required, either 'gnu' or 'bsd' Sets install.cmd to either
     529                                                'gnumake' or 'bsdmake' accordingly</para>
     530                                        <para><userinput>install.type     gnu</userinput>
     531                                        </para>
     532                                </listitem>
     533                        </varlistentry>
     534                       
     535                        <varlistentry id='install.pre_args'>
     536                                <term>install.pre_args</term>
     537                                <listitem>
     538                                        <para>Arguments to pass to &dollar;&lcub;install.cmd&rcub; before &dollar;&lcub;install.args&rcub;. Read only. Set to  &dollar;&lcub;install.target&rcub;
     539                                        </para>
     540                                </listitem>
     541                        </varlistentry>
     542                       
     543                        <varlistentry id='install.args'>
     544                                <term>install.args</term>
     545                                <listitem>
     546                                        <para>Arguments to pass to &dollar;&lcub;install.cmd&rcub;</para>
     547                                        <para><userinput>install.args     -DNOWARN</userinput>
     548                                        </para>
     549                                </listitem>
     550                        </varlistentry>
     551                       
     552                        <varlistentry id='install.target'>
     553                                <term>install.target</term>
     554                                <listitem>
     555                                        <para>Install target to pass to ${install.cmd}.</para>
     556                                        <para><userinput>install.target all-src</userinput>
     557                                        </para>
     558                                </listitem>
     559                        </varlistentry>
     560<para></para>
    526561        </sect1>
    527562        <sect1>
Note: See TracChangeset for help on using the changeset viewer.