Changeset 32050 for trunk/doc-new


Ignore:
Timestamp:
Dec 14, 2007, 3:34:19 PM (12 years ago)
Author:
simon@…
Message:

doc-new: Splitted portfile-keywords.xml and moved Dependencies, Variants and Livecheck to own files. No code changes to these files except id fixes.

Location:
trunk/doc-new
Files:
3 added
5 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc-new/guide/xml/portfile-keywords.xml

    r32049 r32050  
    1515  be used during a particular installation phase.</para>
    1616
    17   <section id="reference.keywords.general">
    18     <title>General</title>
     17  <variablelist>
     18    <varlistentry>
     19      <term>PortSystem</term>
    1920
    20     <para>The list of global keywords.</para>
     21      <listitem>
     22        <para>The top line of every Portfile; it must be followed by a blank
     23        line. It defines which version of the Portfile interpreter will be
     24        used.</para>
    2125
    22     <variablelist>
    23       <varlistentry>
    24         <term>PortSystem</term>
    25 
    26         <listitem>
    27           <para>The top line of every Portfile; it must be followed by a blank
    28           line. It defines which version of the Portfile interpreter will be
    29           used.</para>
    30 
    31           <programlisting>PortSystem          1.0
     26        <programlisting>PortSystem          1.0
    3227
    3328</programlisting>
    34         </listitem>
    35       </varlistentry>
     29      </listitem>
     30    </varlistentry>
    3631
    37       <varlistentry>
    38         <term>name</term>
     32    <varlistentry>
     33      <term>name</term>
    3934
    40         <listitem>
    41           <para>The name of the Port; it should be lowercase to prevent
    42           uninstallation problems due to a macports base bug.</para>
     35      <listitem>
     36        <para>The name of the Port; it should be lowercase to prevent
     37        uninstallation problems due to a macports base bug.</para>
    4338
    44           <programlisting>name                foo</programlisting>
    45         </listitem>
    46       </varlistentry>
     39        <programlisting>name                foo</programlisting>
     40      </listitem>
     41    </varlistentry>
    4742
    48       <varlistentry>
    49         <term>version</term>
     43    <varlistentry>
     44      <term>version</term>
    5045
    51         <listitem>
    52           <para>The version of the ported software.</para>
     46      <listitem>
     47        <para>The version of the ported software.</para>
    5348
    54           <programlisting>version             1.23.45</programlisting>
    55         </listitem>
    56       </varlistentry>
     49        <programlisting>version             1.23.45</programlisting>
     50      </listitem>
     51    </varlistentry>
    5752
    58       <varlistentry>
    59         <term>revision</term>
     53    <varlistentry>
     54      <term>revision</term>
    6055
    61         <listitem>
    62           <para>Optional keyword (default is 0) that is used to track port
    63           revisions. It should not be incremented for port revisions unless it
    64           would benefit users to upgrade an installed port, and cleared when
    65           the port is updated to a newer version.</para>
     56      <listitem>
     57        <para>Optional keyword (default is 0) that is used to track port
     58        revisions. It should not be incremented for port revisions unless it
     59        would benefit users to upgrade an installed port, and cleared when
     60        the port is updated to a newer version.</para>
    6661
    67           <para>It should be used if a bug in the Portfile was found and all
    68           installations of this port have to be updated. If the change only
    69           affects new installations, there is no need to increase it.</para>
     62        <para>It should be used if a bug in the Portfile was found and all
     63        installations of this port have to be updated. If the change only
     64        affects new installations, there is no need to increase it.</para>
    7065
    71           <programlisting>revision            1</programlisting>
    72         </listitem>
    73       </varlistentry>
     66        <programlisting>revision            1</programlisting>
     67      </listitem>
     68    </varlistentry>
    7469
    75       <varlistentry>
    76         <term>epoch</term>
     70    <varlistentry>
     71      <term>epoch</term>
    7772
    78         <listitem>
    79           <para>An optional keyword (default value is 0) that may be used when
    80           ports are updated to a version that is numerically less than the
    81           previous version. For example 1.10 -&gt; 1.2 or 20070928 -&gt; 1.0.
    82           An epoch ensures that port version comparisons work correctly in
    83           these cases. Often the epoch is formatted like a date, but it can
    84           simply be a number such as 1.</para>
     73      <listitem>
     74        <para>An optional keyword (default value is 0) that may be used when
     75        ports are updated to a version that is numerically less than the
     76        previous version. For example 1.10 -&gt; 1.2 or 20070928 -&gt; 1.0.
     77        An epoch ensures that port version comparisons work correctly in
     78        these cases. Often the epoch is formatted like a date, but it can
     79        simply be a number such as 1.</para>
    8580
    86           <programlisting>epoch               20080924</programlisting>
     81        <programlisting>epoch               20080924</programlisting>
    8782
    88           <programlisting>epoch               1</programlisting>
     83        <programlisting>epoch               1</programlisting>
    8984
    90           <note>
    91             <para>If an epoch is used it must must never be decreased or reset
    92             to zero, because this would always cause a port version comparison
    93             to be incorrect after a port upgrade.</para>
    94           </note>
     85        <note>
     86          <para>If an epoch is used it must must never be decreased or reset
     87          to zero, because this would always cause a port version comparison
     88          to be incorrect after a port upgrade.</para>
     89        </note>
    9590
    96           <para>An epoch is not needed for most ports, and good use of a
    97           port's version can make using an epoch unnecessary even for
    98           application distributions without official version numbers. For
    99           example, if an application version 1.5 is superseded by a snapshot
    100           release 20081022, the new release could be given version number
    101           1.5.20081022, rather than 20081022, so the newer release will have a
    102           numericaly greater value.</para>
    103         </listitem>
    104       </varlistentry>
     91        <para>An epoch is not needed for most ports, and good use of a
     92        port's version can make using an epoch unnecessary even for
     93        application distributions without official version numbers. For
     94        example, if an application version 1.5 is superseded by a snapshot
     95        release 20081022, the new release could be given version number
     96        1.5.20081022, rather than 20081022, so the newer release will have a
     97        numericaly greater value.</para>
     98      </listitem>
     99    </varlistentry>
    105100
    106       <varlistentry>
    107         <term>categories</term>
     101    <varlistentry>
     102      <term>categories</term>
    108103
    109         <listitem>
    110           <para>The category under which the ported software falls. The first
    111           category should be the same as the directory within which the
    112           Portfile is stored; secondary and tertiary categories may be
    113           selected.</para>
     104      <listitem>
     105        <para>The category under which the ported software falls. The first
     106        category should be the same as the directory within which the
     107        Portfile is stored; secondary and tertiary categories may be
     108        selected.</para>
    114109
    115           <programlisting>categories          net security</programlisting>
    116         </listitem>
    117       </varlistentry>
     110        <programlisting>categories          net security</programlisting>
     111      </listitem>
     112    </varlistentry>
    118113
    119       <varlistentry>
    120         <term>maintainers</term>
     114    <varlistentry>
     115      <term>maintainers</term>
    121116
    122         <listitem>
    123           <para>A port's maintainer is a person or persons who take
    124           responsibility for keeping the port up-to-date, and the maintainer
    125           keyword lists maintainer email addresses(s). However, many
    126           maintainers wish to hide these addresses from spambots; to do so
    127           follow these conventions:</para>
     117      <listitem>
     118        <para>A port's maintainer is a person or persons who take
     119        responsibility for keeping the port up-to-date, and the maintainer
     120        keyword lists maintainer email addresses(s). However, many
     121        maintainers wish to hide these addresses from spambots; to do so
     122        follow these conventions:</para>
    128123
    129           <itemizedlist>
    130             <listitem>
    131               <para>For addresses in domain @macports.org, simply omit the
    132               domain name.</para>
    133             </listitem>
     124        <itemizedlist>
     125          <listitem>
     126            <para>For addresses in domain @macports.org, simply omit the
     127            domain name.</para>
     128          </listitem>
    134129
    135             <listitem>
    136               <para>For addresses in other domains, say
    137               <email>account@example.org</email>, use the convention
    138               example.org:account to specify the address.</para>
    139             </listitem>
    140           </itemizedlist>
     130          <listitem>
     131            <para>For addresses in other domains, say
     132            <email>account@example.org</email>, use the convention
     133            example.org:account to specify the address.</para>
     134          </listitem>
     135        </itemizedlist>
    141136
    142           <para>In the example below, the maintainer email addresses
    143           <email>jdoe@macports.org</email> and
    144           <email>julesverne@example.org</email> are hidden using these
    145           conventions.</para>
     137        <para>In the example below, the maintainer email addresses
     138        <email>jdoe@macports.org</email> and
     139        <email>julesverne@example.org</email> are hidden using these
     140        conventions.</para>
    146141
    147           <programlisting>maintainers         jdoe \
     142        <programlisting>maintainers         jdoe \
    148143                    example.org:julesverne</programlisting>
    149         </listitem>
    150       </varlistentry>
     144      </listitem>
     145    </varlistentry>
    151146
    152       <varlistentry>
    153         <term>description</term>
     147    <varlistentry>
     148      <term>description</term>
    154149
    155         <listitem>
    156           <para>A one-sentence description of the ported software.</para>
     150      <listitem>
     151        <para>A one-sentence description of the ported software.</para>
    157152
    158           <programlisting>description         A classic shooter arcade game.</programlisting>
    159         </listitem>
    160       </varlistentry>
     153        <programlisting>description         A classic shooter arcade game.</programlisting>
     154      </listitem>
     155    </varlistentry>
    161156
    162       <varlistentry>
    163         <term>long_description</term>
     157    <varlistentry>
     158      <term>long_description</term>
    164159
    165         <listitem>
    166           <para>A long description of the ported software. Break long lines
    167           with escaped newlines.</para>
     160      <listitem>
     161        <para>A long description of the ported software. Break long lines
     162        with escaped newlines.</para>
    168163
    169           <programlisting>long_description    A classic shooter arcade game derived from \
     164        <programlisting>long_description    A classic shooter arcade game derived from \
    170165                    the game alien-munchers.  Not suitable for \
    171166                    children under two years old.</programlisting>
    172         </listitem>
    173       </varlistentry>
     167      </listitem>
     168    </varlistentry>
    174169
    175       <varlistentry>
    176         <term>homepage</term>
     170    <varlistentry>
     171      <term>homepage</term>
    177172
    178         <listitem>
    179           <para>Port application's homepage.</para>
     173      <listitem>
     174        <para>Port application's homepage.</para>
    180175
    181           <programlisting>homepage            http://www.example.org/apps</programlisting>
    182         </listitem>
    183       </varlistentry>
     176        <programlisting>homepage            http://www.example.org/apps</programlisting>
     177      </listitem>
     178    </varlistentry>
    184179
    185       <varlistentry>
    186         <term>platforms</term>
     180    <varlistentry>
     181      <term>platforms</term>
    187182
    188         <listitem>
    189           <para>The platforms on which the port has been tested.</para>
     183      <listitem>
     184        <para>The platforms on which the port has been tested.</para>
    190185
    191           <programlisting>platforms           darwin freebsd</programlisting>
    192         </listitem>
    193       </varlistentry>
    194     </variablelist>
    195   </section>
    196 
    197   <section id="reference.keywords.dependencies">
    198     <title>Dependencies</title>
    199 
    200     <para>Free and open source software is highly modular, and MacPorts ports
    201     often require that other ports be installed beforehand; these
    202     prerequisites for a given port are called a port's
    203     <quote>dependencies</quote>.</para>
    204 
    205     <para>There are three types of MacPorts dependencies: library, build, and
    206     run dependencies. Dependency types are important for proper port upgrade
    207     and uninstall behavior. For example, you may not uninstall a port that is
    208     a library dependency for another port, though you may remove one with a
    209     build dependency; likewise, upgrading a port will upgrade its library and
    210     build dependencies also, but not its run dependencies.</para>
    211 
    212     <variablelist>
    213       <varlistentry>
    214         <term>depends_lib</term>
    215 
    216         <term>depends_lib-append</term>
    217 
    218         <term>depends_lib-delete</term>
    219 
    220         <listitem>
    221           <para>The list of dependencies to check before phases
    222           <option>configure</option>, <option>build</option>,
    223           <option>destroot</option>, <option>install</option>, and
    224           <option>package</option>. Library dependencies are needed both at
    225           build time (for headers and libraries to link against) and at run
    226           time.</para>
    227         </listitem>
    228       </varlistentry>
    229 
    230       <varlistentry>
    231         <term>depends_build</term>
    232 
    233         <term>depends_build-append</term>
    234 
    235         <term>depends_build-delete</term>
    236 
    237         <listitem>
    238           <para>The list of dependencies to check before phases
    239           <option>build</option>, <option>destroot</option>,
    240           <option>install</option>, and <option>package</option>. Build
    241           dependencies are needed when software is compiled, but not needed at
    242           all once the software is compiled and installed.</para>
    243         </listitem>
    244       </varlistentry>
    245 
    246       <varlistentry>
    247         <term>depends_run</term>
    248 
    249         <term>depends_run-append</term>
    250 
    251         <term>depends_run-delete</term>
    252 
    253         <listitem>
    254           <para>The list of dependencies to check before phases
    255           <option>destroot</option>, <option>install</option>, and
    256           <option>package</option>. Run dependencies are needed when the
    257           software is run, but not to compile it.</para>
    258         </listitem>
    259       </varlistentry>
    260     </variablelist>
    261 
    262     <section id="reference.keywords.dependencies.types">
    263       <title>Port and Non-Port Dependencies</title>
    264 
    265       <para>Port dependencies should be provided by MacPorts ports whenever
    266       possible, however dependencies may be provided by vendor-supplied
    267       software when satisfying a dependency by a port is not practical or
    268       desirable for a special reason. Dependencies of this type are called
    269       non-port dependencies.</para>
    270 
    271       <para>Non-port dependencies should only be used if the application or
    272       library can be installed by multiple ports (for example stable and
    273       -devel version) or if it can't be installed with Macports.</para>
    274 
    275       <para>Port dependencies, the preferred type, are specified as shown in
    276       these examples:</para>
    277 
    278       <programlisting>depends_lib         port:rrdtool port:apache2
    279 
    280 depends_build       port:libtool
    281 
    282 depends_run         port:apache2 port:php5</programlisting>
    283 
    284       <para>Non-port dependencies are specified as shown in these
    285       examples:</para>
    286 
    287       <programlisting>depends_lib         lib:libX11.6:xorg
    288 
    289 depends_build       bin:glibtool:libtool
    290 
    291 depends_run         path:${prefix}/lib/libltdl.a:libtool</programlisting>
    292     </section>
    293   </section>
    294 
    295   <section id="reference.keywords.variants">
    296     <title>Variants</title>
    297 
    298     <para>MacPorts variants are conditional modifications of port installation
    299     behavior that may be invoked by a user at the time of port install.</para>
    300 
    301     <variablelist>
    302       <varlistentry>
    303         <term>variant [requires variant] [conflicts variant] [description
    304         description]</term>
    305 
    306         <listitem>
    307           <para>The variant declaration may contain any keywords that can be
    308           placed in a Portfile's global section. If you wish to execute system
    309           (shell) calls or Tcl extensions during the execution of a port
    310           phase, you should place those statements within a
    311           <literal>variant_isset</literal> conditional within a phase
    312           declaration and not within the variant declaration itself.
    313           Dependencies and conflicts with other variants in the same port can
    314           be expressed with requires and conflicts. See the isset Tcl
    315           extension.</para>
    316 
    317           <itemizedlist>
    318             <listitem>
    319               <para>Default: no</para>
    320             </listitem>
    321 
    322             <listitem>
    323               <para>Example:</para>
    324 
    325               <programlisting>variant gnome requires glib {
    326     configure.args-append   --with-gnome
    327     depends_lib-append      port:gnome-session
    328 }</programlisting>
    329             </listitem>
    330           </itemizedlist>
    331         </listitem>
    332       </varlistentry>
    333 
    334       <varlistentry>
    335         <term>default_variants</term>
    336 
    337         <listitem>
    338           <para>If variants are defined, then the default_variants value lists
    339           which variants are enabled by default. This allows for Portfile
    340           modularity and also allows users to suppress default variants if
    341           they wish.</para>
    342 
    343           <para>Due to a bug in the current Macports base default_variants
    344           shouldn't be used at the moment as they cause problems while
    345           upgrading ports.</para>
    346 
    347           <itemizedlist>
    348             <listitem>
    349               <para>Default: none</para>
    350             </listitem>
    351 
    352             <listitem>
    353               <para>Example:</para>
    354 
    355               <programlisting>default_variants    +ssl +tcpd
    356 
    357 </programlisting>
    358             </listitem>
    359           </itemizedlist>
    360         </listitem>
    361 
    362         <listitem>
    363           <para>Default variants may be suppressed by preceding a variant name
    364           with a "-" as shown in this example.</para>
    365 
    366           <programlisting><prompt>%%</prompt> <userinput>port install foo -ssl</userinput></programlisting>
    367         </listitem>
    368       </varlistentry>
    369 
    370       <varlistentry>
    371         <term>universal_variant</term>
    372 
    373         <listitem>
    374           <para>When using MacPorts on Mac OS X, a universal variant is
    375           defined by default to configure ports with universal flags. The
    376           variant can be overridden if the default code does not work (see the
    377           Configure Universal section below), or suppressed if a universal
    378           variant is not possible for the port with this keyword.</para>
    379 
    380           <itemizedlist>
    381             <listitem>
    382               <para>Default: yes</para>
    383             </listitem>
    384 
    385             <listitem>
    386               <para>Example:</para>
    387 
    388               <programlisting>universal_variant   no</programlisting>
    389             </listitem>
    390           </itemizedlist>
    391         </listitem>
    392       </varlistentry>
    393     </variablelist>
    394   </section>
    395 
    396   <section id="reference.keywords.livecheck">
    397     <title>Livecheck / Distcheck</title>
    398 
    399     <para>Options livecheck and distcheck are especially useful for port
    400     maintainers, but others may also find this information valuable.</para>
    401 
    402     <para>Livecheck checks to see if MacPorts can query the developer's
    403     download site to determine if a newer version of the software has become
    404     available since the port was installed.</para>
    405 
    406     <variablelist>
    407       <varlistentry>
    408         <term>livecheck.check</term>
    409 
    410         <listitem>
    411           <para>Specify what kind of update check to perform.</para>
    412 
    413           <para>Open source mirror site options are to use the project's
    414           latest file release from <option>sourceforge</option> or
    415           <option>googlecode</option>, or the project's
    416           <literal>date_updated</literal> XML tag for
    417           <option>freshmeat</option>. These options are automatically used if
    418           a matching <varname>${master_sites}</varname> URL is used.</para>
    419 
    420           <para>Generic download site options are to specify a
    421           <option>moddate</option> (modification date of a URL resource), a
    422           <option>regex</option> (retrieve the version by applying a regex to
    423           a URL resource), <option>regexm</option> (retrieve the version by
    424           applying a multi-line regex to a URL resource), <option>md5</option>
    425           (compares the md5 sum of a URL resource) or <option>none</option>
    426           (no check).</para>
    427 
    428           <itemizedlist>
    429             <listitem>
    430               <para>Default: <option>sourceforge</option> or
    431               <option>googlecode</option> if the
    432               <varname>${master_sites}</varname> is one of these, else
    433               <option>freshmeat</option>.</para>
    434             </listitem>
    435 
    436             <listitem>
    437               <para>Values: <option>freshmeat</option>
    438               <option>sourceforge</option> <option>googlecode</option>
    439               <option>moddate</option> <option>regex</option>
    440               <option>regexm</option> <option>md5</option>
    441               <option>none</option></para>
    442             </listitem>
    443 
    444             <listitem>
    445               <para>Examples:</para>
    446 
    447               <programlisting>livecheck.check     regex
    448 livecheck.url       ${homepage}
    449 livecheck.regex     "Generally Available (\\d+(?:\\.\\d+)*)"</programlisting>
    450             </listitem>
    451           </itemizedlist>
    452         </listitem>
    453       </varlistentry>
    454 
    455       <varlistentry>
    456         <term>livecheck.name</term>
    457 
    458         <listitem>
    459           <para>Name of the project for live checks. Is only used with
    460           freshmeat, sourceforge, and googlecode livechecks.</para>
    461 
    462           <itemizedlist>
    463             <listitem>
    464               <para>Default: <varname>${name}</varname> or the sourceforge,
    465               freshmeat or googlecode project name if it can be guessed from
    466               <varname>${master_sites}</varname>.</para>
    467             </listitem>
    468 
    469             <listitem>
    470               <para>Example:</para>
    471 
    472               <programlisting>livecheck.name      hibernate</programlisting>
    473             </listitem>
    474           </itemizedlist>
    475         </listitem>
    476       </varlistentry>
    477 
    478       <varlistentry>
    479         <term>livecheck.distname</term>
    480 
    481         <listitem>
    482           <para>Name of the file release for sourceforge and googlecode
    483           checks. For sourceforge releases use the name of the package
    484           release. For googlecode releases use the name of the file download,
    485           including extension. You may use this keyword without
    486           <code>livecheck.version</code> if you replace the version part of
    487           the name with "<literal>(.*)</literal>".</para>
    488 
    489           <itemizedlist>
    490             <listitem>
    491               <para>Default: sourceforge:
    492               <varname>${livecheck.name}</varname>, googlecode: first
    493               <varname>${distfiles}</varname> item</para>
    494             </listitem>
    495 
    496             <listitem>
    497               <para>Example:</para>
    498 
    499               <programlisting>livecheck.distname  faad2.src</programlisting>
    500             </listitem>
    501           </itemizedlist>
    502         </listitem>
    503       </varlistentry>
    504 
    505       <varlistentry>
    506         <term>livecheck.version</term>
    507 
    508         <listitem>
    509           <para>Version of the project for a check; used for regex-based
    510           checks.</para>
    511 
    512           <itemizedlist>
    513             <listitem>
    514               <para>Default: <varname>${version}</varname></para>
    515             </listitem>
    516 
    517             <listitem>
    518               <para>Example:</para>
    519 
    520               <programlisting>livecheck.version   ${name}-${version}</programlisting>
    521             </listitem>
    522           </itemizedlist>
    523         </listitem>
    524       </varlistentry>
    525 
    526       <varlistentry>
    527         <term>livecheck.url</term>
    528 
    529         <listitem>
    530           <para>URL to query for a check.</para>
    531 
    532           <itemizedlist>
    533             <listitem>
    534               <para>Default:</para>
    535 
    536               <itemizedlist>
    537                 <listitem>
    538                   <para><varname>${homepage}</varname> or the first hit among
    539                   the following sites:</para>
    540                 </listitem>
    541 
    542                 <listitem>
    543                   <para><literal>http://freshmeat.net/projects-xml/${livecheck.name}/${livecheck.name}.xml</literal></para>
    544                 </listitem>
    545 
    546                 <listitem>
    547                   <para><literal>http://sourceforge.net/export/rss2_projfiles.php?project=${livecheck.name}</literal></para>
    548                 </listitem>
    549 
    550                 <listitem>
    551                   <para><literal>http://code.google.com/p/${livecheck.name}/downloads/list</literal></para>
    552                 </listitem>
    553               </itemizedlist>
    554             </listitem>
    555 
    556             <listitem>
    557               <para>Example:</para>
    558 
    559               <programlisting>livecheck.url       http://ftp.gnu.org/gnu/bison/</programlisting>
    560             </listitem>
    561           </itemizedlist>
    562         </listitem>
    563       </varlistentry>
    564 
    565       <varlistentry>
    566         <term>livecheck.regex</term>
    567 
    568         <listitem>
    569           <para>Regular expression to parse the resource for regex checks. Be
    570           sure to use a regular expression grouping around the version
    571           component.</para>
    572 
    573           <itemizedlist>
    574             <listitem>
    575               <para>Default: none</para>
    576             </listitem>
    577 
    578             <listitem>
    579               <para>Example:</para>
    580 
    581               <programlisting>livecheck.regex     4th-([a-z0-9.]+)-unix${extract.suffix}</programlisting>
    582 
    583               <!-- TODO: add more examples -->
    584 
    585             </listitem>
    586           </itemizedlist>
    587         </listitem>
    588       </varlistentry>
    589 
    590       <varlistentry>
    591         <term>livecheck.md5</term>
    592 
    593         <listitem>
    594           <para>md5 checksum to use for an md5 comparison.</para>
    595 
    596           <itemizedlist>
    597             <listitem>
    598               <para>Default: none</para>
    599             </listitem>
    600 
    601             <listitem>
    602               <para>Example:</para>
    603 
    604               <programlisting>livecheck.md5       37e6a5b6516a680c7178b72021d3b706</programlisting>
    605             </listitem>
    606           </itemizedlist>
    607         </listitem>
    608       </varlistentry>
    609     </variablelist>
    610 
    611     <para>Distcheck reports whether or not the distfile(s) specified in a
    612     Portfile are still available on the developer's download site. Examples
    613     are given below.</para>
    614 
    615     <variablelist>
    616       <varlistentry>
    617         <term>distcheck.check</term>
    618 
    619         <listitem>
    620           <para>This option can be used to disable distcheck. It specifies
    621           what kind of check should be performed on distfiles:
    622           <option>moddate</option> (check if the Portfile is older than the
    623           distfile) or <option>none</option> (no check).</para>
    624 
    625           <itemizedlist>
    626             <listitem>
    627               <para>Default: <option>moddate</option></para>
    628             </listitem>
    629 
    630             <listitem>
    631               <para>Example:</para>
    632 
    633               <programlisting>distcheck.check     none</programlisting>
    634             </listitem>
    635           </itemizedlist>
    636         </listitem>
    637       </varlistentry>
    638     </variablelist>
    639   </section>
     186        <programlisting>platforms           darwin freebsd</programlisting>
     187      </listitem>
     188    </varlistentry>
     189  </variablelist>
    640190</section>
  • trunk/doc-new/guide/xml/portfiledev.xml

    r32018 r32050  
    135135        keyword lists maintainer email addresses(s). To hide these addresses
    136136        from spambots, see the more full explanation of the maintainer keyword
    137         in the <link linkend="reference.keywords.general">Global
    138         Keywords</link> section of the <link linkend="reference">Portfile
    139         Reference</link> chapter.</para>
     137        in the <link linkend="reference.keywords">Global Keywords</link>
     138        section of the <link linkend="reference">Portfile Reference</link>
     139        chapter.</para>
    140140
    141141        <programlisting>maintainers         julesverne@example.org</programlisting>
  • trunk/doc-new/guide/xml/portfileref.xml

    r32049 r32050  
    99  Tcl extensions.</para>
    1010
    11   <xi:include href="portfile-variables.xml"
     11  <xi:include href="portfile-keywords.xml"
    1212              xmlns:xi="http://www.w3.org/2001/XInclude" />
    1313
    14   <xi:include href="portfile-keywords.xml"
     14  <xi:include href="portfile-variables.xml"
    1515              xmlns:xi="http://www.w3.org/2001/XInclude" />
    1616
     
    1818              xmlns:xi="http://www.w3.org/2001/XInclude" />
    1919
     20  <xi:include href="portfile-dependencies.xml"
     21              xmlns:xi="http://www.w3.org/2001/XInclude" />
     22
     23  <xi:include href="portfile-variants.xml"
     24              xmlns:xi="http://www.w3.org/2001/XInclude" />
     25
     26  <xi:include href="portfile-tcl.xml"
     27              xmlns:xi="http://www.w3.org/2001/XInclude" />
     28
    2029  <xi:include href="portfile-startupitem.xml"
    2130              xmlns:xi="http://www.w3.org/2001/XInclude" />
    2231
    23   <xi:include href="portfile-tcl.xml"
     32  <xi:include href="portfile-livecheck.xml"
    2433              xmlns:xi="http://www.w3.org/2001/XInclude" />
    2534
  • trunk/doc-new/guide/xml/using.xml

    r32019 r32050  
    309309      download site. It's especially useful for port maintainers, but others
    310310      may also wish to see if a port has the latest available distribution
    311       source. See section <link
    312       linkend="reference.keywords.livecheck">Livecheck</link> for more
    313       information.</para>
     311      source. See section <link linkend="reference.livecheck">Livecheck</link>
     312      for more information.</para>
    314313
    315314      <programlisting><prompt>%%</prompt> <userinput>port livecheck rrdtool</userinput></programlisting>
  • trunk/doc-new/man/xml/portfile.7.xml

    r32049 r32050  
    2828  </refsection>
    2929
    30   <xi:include href="../tmp/portfile-variables.xml"
     30  <xi:include href="../tmp/portfile-keywords.xml"
    3131              xmlns:xi="http://www.w3.org/2001/XInclude" />
    3232
    33   <xi:include href="../tmp/portfile-keywords.xml"
     33  <xi:include href="../tmp/portfile-variables.xml"
    3434              xmlns:xi="http://www.w3.org/2001/XInclude" />
    3535
     
    3737              xmlns:xi="http://www.w3.org/2001/XInclude" />
    3838
     39  <xi:include href="../tmp/portfile-dependencies.xml"
     40              xmlns:xi="http://www.w3.org/2001/XInclude" />
     41
     42  <xi:include href="../tmp/portfile-variants.xml"
     43              xmlns:xi="http://www.w3.org/2001/XInclude" />
     44
     45  <xi:include href="../tmp/portfile-tcl.xml"
     46              xmlns:xi="http://www.w3.org/2001/XInclude" />
     47
    3948  <xi:include href="../tmp/portfile-startupitem.xml"
    4049              xmlns:xi="http://www.w3.org/2001/XInclude" />
    4150
    42   <xi:include href="../tmp/portfile-tcl.xml"
     51  <xi:include href="../tmp/portfile-livecheck.xml"
    4352              xmlns:xi="http://www.w3.org/2001/XInclude" />
    4453
Note: See TracChangeset for help on using the changeset viewer.