Changeset 32715 for trunk/doc-new


Ignore:
Timestamp:
Jan 11, 2008, 10:51:21 PM (12 years ago)
Author:
markd@…
Message:

Revise epoch section.

File:
1 edited

Legend:

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

    r32051 r32715  
    5757        <para>Optional keyword (default is 0) that is used to track port
    5858        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>
     59        would benefit users to upgrade an installed port, and cleared when the
     60        port is updated to a newer version.</para>
    6161
    6262        <para>It should be used if a bug in the Portfile was found and all
     
    7474        <para>An optional keyword (default value is 0) that may be used when
    7575        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>
     76        previous version. For example 1.10 -&gt; 1.2 or 20070928 -&gt; 1.0. An
     77        epoch ensures that port version comparisons work correctly in these
     78        cases. Often the epoch is formatted like a date, but it can simply be
     79        a number such as 1.</para>
    8080
    8181        <programlisting>epoch               20080924</programlisting>
     
    8484
    8585        <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>
     86          <para>An epoch is not needed for most ports. If an epoch is used it
     87          must never be decreased without updating the port's version number;
     88          this will cause port version comparisons to be incorrect.</para>
    8989        </note>
    90 
    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         numerically greater value.</para>
    9890      </listitem>
    9991    </varlistentry>
     
    10496      <listitem>
    10597        <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>
     98        category should be the same as the directory within which the Portfile
     99        is stored; secondary and tertiary categories may be selected.</para>
    109100
    110101        <programlisting>categories          net security</programlisting>
     
    118109        <para>A port's maintainer is a person or persons who take
    119110        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>
     111        keyword lists maintainer email addresses(s). However, many maintainers
     112        wish to hide these addresses from spambots; to do so follow these
     113        conventions:</para>
    123114
    124115        <itemizedlist>
     
    159150
    160151      <listitem>
    161         <para>A long description of the ported software. Break long lines
    162         with escaped newlines.</para>
     152        <para>A long description of the ported software. Break long lines with
     153        escaped newlines.</para>
    163154
    164155        <programlisting>long_description    A classic shooter arcade game derived from \
Note: See TracChangeset for help on using the changeset viewer.