summaryrefslogtreecommitdiffstats
path: root/doc/meta.xml
diff options
context:
space:
mode:
authorMichael Raskin <7c6f434c@mail.ru>2014-09-03 02:09:52 +0400
committerMichael Raskin <7c6f434c@mail.ru>2014-09-03 02:10:00 +0400
commite39b1f4ec8740e7dd34185c38464db5ac814eed5 (patch)
tree683b46306ee7751b1aea45b0a2ff72d5727d0f69 /doc/meta.xml
parent3a33731e5468b52c887154192d2b970e8bbf04f8 (diff)
Add a few meta-attribute descriptions; rewrite the meta-attribure list description to mean that it is expected that all used meta-attributes are described in the manual.
Diffstat (limited to 'doc/meta.xml')
-rw-r--r--doc/meta.xml28
1 files changed, 24 insertions, 4 deletions
diff --git a/doc/meta.xml b/doc/meta.xml
index e91f94d15c24..fc0ff9777922 100644
--- a/doc/meta.xml
+++ b/doc/meta.xml
@@ -84,8 +84,7 @@ hello-2.3 A program that produces a familiar, friendly greeting
<section><title>Standard meta-attributes</title>
-<para>The following meta-attributes have a standard
-interpretation:</para>
+<para>It is expected that each meta-attribute is one of the following:</para>
<variablelist>
@@ -113,12 +112,23 @@ interpretation:</para>
</varlistentry>
<varlistentry>
+ <term><varname>version</varname></term>
+ <listitem><para>Package version.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><varname>homepage</varname></term>
<listitem><para>The package’s homepage. Example:
<literal>http://www.gnu.org/software/hello/manual/</literal></para></listitem>
</varlistentry>
<varlistentry>
+ <term><varname>downloadPage</varname></term>
+ <listitem><para>The page where a link to the current version can be found. Example:
+ <literal>http://ftp.gnu.org/gnu/hello/</literal></para></listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><varname>license</varname></term>
<listitem><para>The license for the package. One from the
attribute set defined in <link
@@ -195,6 +205,16 @@ meta.hydraPlatforms = [];
they are fixed.</para></listitem>
</varlistentry>
+ <varlistentry>
+ <term><varname>updateWalker</varname></term>
+ <listitem><para>If set to <literal>true</literal>, the package is
+ tested to be updated correctly by the <literal>update-walker.sh</literal>
+ script without additional settings. Such packages have
+ <varname>meta.version</varname> set and their homepage (or
+ the page specified by <varname>meta.downloadPage</varname>) contains
+ a direct link to the package tarball.</para></listitem>
+ </varlistentry>
+
</variablelist>
@@ -256,9 +276,9 @@ to indicate the specific license:
</variablelist>
</para>
-
+
</section>
-
+
</chapter>