Changeset 32047 for trunk/doc-new


Ignore:
Timestamp:
Dec 14, 2007, 2:36:48 PM (12 years ago)
Author:
simon@…
Message:

doc-new: Integrated "Livecheck" section from the old portfile.7 man page. Please check this if everything is ok.

File:
1 edited

Legend:

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

    r31987 r32047  
    415415          <option>googlecode</option>, or the project's
    416416          <literal>date_updated</literal> XML tag for
    417           <option>freshmeat</option>.</para>
     417          <option>freshmeat</option>. These options are automatically used if
     418          a matching <varname>${master_sites}</varname> URL is used.</para>
    418419
    419420          <para>Generic download site options are to specify a
    420           <option>moddate</option> (modification date) of a URL resource), a
     421          <option>moddate</option> (modification date of a URL resource), a
    421422          <option>regex</option> (retrieve the version by applying a regex to
    422423          a URL resource), <option>regexm</option> (retrieve the version by
     
    427428          <itemizedlist>
    428429            <listitem>
    429               <para>Default: sourceforge or googlecode if the master_sites is
    430               one of these, else freshmeat.</para>
    431             </listitem>
    432 
    433             <listitem>
    434               <para>Values: freshmeat sourceforge googlecode moddate regex
    435               regexm md5 none</para>
     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>
    436442            </listitem>
    437443
     
    451457
    452458        <listitem>
    453           <para>Name of the project for live checks; only used with freshmeat,
    454           sourceforge, and googlecode livechecks.</para>
    455 
    456           <itemizedlist>
    457             <listitem>
    458               <para>Default: <varname>${name}</varname> or the
    459               sourceforge/freshmeat/googlecode project name if it can be
    460               guessed from <literal>master_sites</literal>.</para>
    461             </listitem>
    462 
    463             <listitem>
    464               <para>Values: <replaceable>any_project_name</replaceable></para>
     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>
    465467            </listitem>
    466468
     
    479481        <listitem>
    480482          <para>Name of the file release for sourceforge and googlecode
    481           checks. You may use this keyword without livecheck.version if you
    482           replace the version part of the name with "(.*)".</para>
    483 
    484           <itemizedlist>
    485             <listitem>
    486               <para>Default: SourceForge: <varname>${livecheck.name}</varname>
    487               ; GoogleCode: first ${distfiles} item</para>
    488             </listitem>
    489 
    490             <listitem>
    491               <para>Values: <replaceable>filename</replaceable></para>
     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>
    492494            </listitem>
    493495
     
    514516
    515517            <listitem>
    516               <para>Values: <replaceable>any_version</replaceable></para>
    517             </listitem>
    518 
    519             <listitem>
    520518              <para>Example:</para>
    521519
     
    538536              <itemizedlist>
    539537                <listitem>
    540                   <para>homepage or the first hit among the following
    541                   sites</para>
     538                  <para><varname>${homepage}</varname> or the first hit among
     539                  the following sites:</para>
    542540                </listitem>
    543541
    544542                <listitem>
    545                   <para>http://freshmeat.net/projects-xml/${livecheck.name}/${livecheck.name}.xml</para>
     543                  <para><literal>http://freshmeat.net/projects-xml/${livecheck.name}/${livecheck.name}.xml</literal></para>
    546544                </listitem>
    547545
    548546                <listitem>
    549                   <para>http://sourceforge.net/export/rss2_projfiles.php?project=${livecheck.name}</para>
     547                  <para><literal>http://sourceforge.net/export/rss2_projfiles.php?project=${livecheck.name}</literal></para>
    550548                </listitem>
    551549
    552550                <listitem>
    553                   <para>http://code.google.com/p/${livecheck.name}/downloads/list</para>
     551                  <para><literal>http://code.google.com/p/${livecheck.name}/downloads/list</literal></para>
    554552                </listitem>
    555553              </itemizedlist>
    556             </listitem>
    557 
    558             <listitem>
    559               <para>Values: <replaceable>any_url</replaceable></para>
    560554            </listitem>
    561555
     
    583577
    584578            <listitem>
    585               <para>Values: <replaceable>any_regex</replaceable></para>
    586             </listitem>
    587 
    588             <listitem>
    589               <para>Example:</para>
    590 
    591               <programlisting>livecheck.regex     4th-([a-z0-9.]+)-unix.tar.gz</programlisting>
     579              <para>Example:</para>
     580
     581              <programlisting>livecheck.regex     4th-([a-z0-9.]+)-unix${extract.suffix}</programlisting>
     582
     583              <!-- TODO: add more examples -->
     584
    592585            </listitem>
    593586          </itemizedlist>
     
    604597            <listitem>
    605598              <para>Default: none</para>
    606             </listitem>
    607 
    608             <listitem>
    609               <para>Values: <replaceable>any_md5_checksum</replaceable></para>
    610599            </listitem>
    611600
     
    630619        <listitem>
    631620          <para>This option can be used to disable distcheck. It specifies
    632           what kind of check should be performed on distfiles: moddate (check
    633           if the Portfile is older than the distfile) or none (no
    634           check).</para>
    635 
    636           <itemizedlist>
    637             <listitem>
    638               <para>Default: moddate</para>
    639             </listitem>
    640 
    641             <listitem>
    642               <para>Values: moddate none</para>
     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>
    643628            </listitem>
    644629
Note: See TracChangeset for help on using the changeset viewer.