[32047] trunk/doc-new/guide/xml/portfile-global-keywords.7.xml

simon at macports.org simon at macports.org
Fri Dec 14 06:36:51 PST 2007


Revision: 32047
          http://trac.macosforge.org/projects/macports/changeset/32047
Author:   simon at macports.org
Date:     2007-12-14 06:36:48 -0800 (Fri, 14 Dec 2007)

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

Modified Paths:
--------------
    trunk/doc-new/guide/xml/portfile-global-keywords.7.xml

Modified: trunk/doc-new/guide/xml/portfile-global-keywords.7.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-global-keywords.7.xml	2007-12-14 14:22:03 UTC (rev 32046)
+++ trunk/doc-new/guide/xml/portfile-global-keywords.7.xml	2007-12-14 14:36:48 UTC (rev 32047)
@@ -414,10 +414,11 @@
           latest file release from <option>sourceforge</option> or
           <option>googlecode</option>, or the project's
           <literal>date_updated</literal> XML tag for
-          <option>freshmeat</option>.</para>
+          <option>freshmeat</option>. These options are automatically used if
+          a matching <varname>${master_sites}</varname> URL is used.</para>
 
           <para>Generic download site options are to specify a
-          <option>moddate</option> (modification date) of a URL resource), a
+          <option>moddate</option> (modification date of a URL resource), a
           <option>regex</option> (retrieve the version by applying a regex to
           a URL resource), <option>regexm</option> (retrieve the version by
           applying a multi-line regex to a URL resource), <option>md5</option>
@@ -426,13 +427,18 @@
 
           <itemizedlist>
             <listitem>
-              <para>Default: sourceforge or googlecode if the master_sites is
-              one of these, else freshmeat.</para>
+              <para>Default: <option>sourceforge</option> or
+              <option>googlecode</option> if the
+              <varname>${master_sites}</varname> is one of these, else
+              <option>freshmeat</option>.</para>
             </listitem>
 
             <listitem>
-              <para>Values: freshmeat sourceforge googlecode moddate regex
-              regexm md5 none</para>
+              <para>Values: <option>freshmeat</option>
+              <option>sourceforge</option> <option>googlecode</option>
+              <option>moddate</option> <option>regex</option>
+              <option>regexm</option> <option>md5</option>
+              <option>none</option></para>
             </listitem>
 
             <listitem>
@@ -450,21 +456,17 @@
         <term>livecheck.name</term>
 
         <listitem>
-          <para>Name of the project for live checks; only used with freshmeat,
-          sourceforge, and googlecode livechecks.</para>
+          <para>Name of the project for live checks. Is only used with
+          freshmeat, sourceforge, and googlecode livechecks.</para>
 
           <itemizedlist>
             <listitem>
-              <para>Default: <varname>${name}</varname> or the
-              sourceforge/freshmeat/googlecode project name if it can be
-              guessed from <literal>master_sites</literal>.</para>
+              <para>Default: <varname>${name}</varname> or the sourceforge,
+              freshmeat or googlecode project name if it can be guessed from
+              <varname>${master_sites}</varname>.</para>
             </listitem>
 
             <listitem>
-              <para>Values: <replaceable>any_project_name</replaceable></para>
-            </listitem>
-
-            <listitem>
               <para>Example:</para>
 
               <programlisting>livecheck.name      hibernate</programlisting>
@@ -478,20 +480,20 @@
 
         <listitem>
           <para>Name of the file release for sourceforge and googlecode
-          checks. You may use this keyword without livecheck.version if you
-          replace the version part of the name with "(.*)".</para>
+          checks. For sourceforge releases use the name of the package
+          release. For googlecode releases use the name of the file download,
+          including extension. You may use this keyword without
+          <code>livecheck.version</code> if you replace the version part of
+          the name with "<literal>(.*)</literal>".</para>
 
           <itemizedlist>
             <listitem>
-              <para>Default: SourceForge: <varname>${livecheck.name}</varname>
-              ; GoogleCode: first ${distfiles} item</para>
+              <para>Default: sourceforge:
+              <varname>${livecheck.name}</varname>, googlecode: first
+              <varname>${distfiles}</varname> item</para>
             </listitem>
 
             <listitem>
-              <para>Values: <replaceable>filename</replaceable></para>
-            </listitem>
-
-            <listitem>
               <para>Example:</para>
 
               <programlisting>livecheck.distname  faad2.src</programlisting>
@@ -513,10 +515,6 @@
             </listitem>
 
             <listitem>
-              <para>Values: <replaceable>any_version</replaceable></para>
-            </listitem>
-
-            <listitem>
               <para>Example:</para>
 
               <programlisting>livecheck.version   ${name}-${version}</programlisting>
@@ -537,29 +535,25 @@
 
               <itemizedlist>
                 <listitem>
-                  <para>homepage or the first hit among the following
-                  sites</para>
+                  <para><varname>${homepage}</varname> or the first hit among
+                  the following sites:</para>
                 </listitem>
 
                 <listitem>
-                  <para>http://freshmeat.net/projects-xml/${livecheck.name}/${livecheck.name}.xml</para>
+                  <para><literal>http://freshmeat.net/projects-xml/${livecheck.name}/${livecheck.name}.xml</literal></para>
                 </listitem>
 
                 <listitem>
-                  <para>http://sourceforge.net/export/rss2_projfiles.php?project=${livecheck.name}</para>
+                  <para><literal>http://sourceforge.net/export/rss2_projfiles.php?project=${livecheck.name}</literal></para>
                 </listitem>
 
                 <listitem>
-                  <para>http://code.google.com/p/${livecheck.name}/downloads/list</para>
+                  <para><literal>http://code.google.com/p/${livecheck.name}/downloads/list</literal></para>
                 </listitem>
               </itemizedlist>
             </listitem>
 
             <listitem>
-              <para>Values: <replaceable>any_url</replaceable></para>
-            </listitem>
-
-            <listitem>
               <para>Example:</para>
 
               <programlisting>livecheck.url       http://ftp.gnu.org/gnu/bison/</programlisting>
@@ -582,13 +576,12 @@
             </listitem>
 
             <listitem>
-              <para>Values: <replaceable>any_regex</replaceable></para>
-            </listitem>
-
-            <listitem>
               <para>Example:</para>
 
-              <programlisting>livecheck.regex     4th-([a-z0-9.]+)-unix.tar.gz</programlisting>
+              <programlisting>livecheck.regex     4th-([a-z0-9.]+)-unix${extract.suffix}</programlisting>
+
+              <!-- TODO: add more examples -->
+
             </listitem>
           </itemizedlist>
         </listitem>
@@ -606,10 +599,6 @@
             </listitem>
 
             <listitem>
-              <para>Values: <replaceable>any_md5_checksum</replaceable></para>
-            </listitem>
-
-            <listitem>
               <para>Example:</para>
 
               <programlisting>livecheck.md5       37e6a5b6516a680c7178b72021d3b706</programlisting>
@@ -629,20 +618,16 @@
 
         <listitem>
           <para>This option can be used to disable distcheck. It specifies
-          what kind of check should be performed on distfiles: moddate (check
-          if the Portfile is older than the distfile) or none (no
-          check).</para>
+          what kind of check should be performed on distfiles:
+          <option>moddate</option> (check if the Portfile is older than the
+          distfile) or <option>none</option> (no check).</para>
 
           <itemizedlist>
             <listitem>
-              <para>Default: moddate</para>
+              <para>Default: <option>moddate</option></para>
             </listitem>
 
             <listitem>
-              <para>Values: moddate none</para>
-            </listitem>
-
-            <listitem>
               <para>Example:</para>
 
               <programlisting>distcheck.check     none</programlisting>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.macosforge.org/pipermail/macports-changes/attachments/20071214/424fe14d/attachment-0001.html


More information about the macports-changes mailing list