diff options
author | A. Wilcox <AWilcox@Wilcox-Tech.com> | 2020-06-13 15:52:16 -0500 |
---|---|---|
committer | A. Wilcox <AWilcox@Wilcox-Tech.com> | 2020-06-13 15:52:16 -0500 |
commit | 0449dbe11ce3413914ba49b1b8974d2241bad6e4 (patch) | |
tree | 80cd5d17403dd1dad0fc7fa975bc52830fa95e74 /devel/script/2_keys.xml | |
parent | 95d1635be3f65ac35f07e8f33f51af2912ba1ec2 (diff) | |
download | horizon-0449dbe11ce3413914ba49b1b8974d2241bad6e4.tar.gz horizon-0449dbe11ce3413914ba49b1b8974d2241bad6e4.tar.bz2 horizon-0449dbe11ce3413914ba49b1b8974d2241bad6e4.tar.xz horizon-0449dbe11ce3413914ba49b1b8974d2241bad6e4.zip |
devel: script: Document the 'version' key
Diffstat (limited to 'devel/script/2_keys.xml')
-rw-r--r-- | devel/script/2_keys.xml | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/devel/script/2_keys.xml b/devel/script/2_keys.xml index c37ecc1..42290ea 100644 --- a/devel/script/2_keys.xml +++ b/devel/script/2_keys.xml @@ -510,6 +510,37 @@ timezone Africa/Nairobi </para> </formalpara> </section> + <section id="version"> + <title><literal>version</literal></title> + <formalpara id="version.name"> + <title>Name</title> + <para><literal>version</literal></para> + </formalpara> + <formalpara id="version.purpose"> + <title>Purpose</title> + <para>The <literal>version</literal> key specifies the version of Adélie Linux being installed. The value of this key is used if <literal>repository</literal> is not specified to determine the repositories to use by default. If <literal>repository</literal> is provided, this key has no effect.</para> + </formalpara> + <formalpara id="version.format"> + <title>Format</title> + <para>The <literal>version</literal> key is a string value which describes a version of Adélie Linux.</para> + </formalpara> + <formalpara id="version.default"> + <title>Default</title> + <para>If the <literal>version</literal> key is not specified, the system will proceed as if the key had been specified with the value "stable".</para> + </formalpara> + <formalpara id="version.example"> + <title>Example</title> + <para> + <example> + <title>The <literal>version</literal> Key</title> + <programlisting> +version 1.1 + </programlisting> + <para>This configures the target computer to install version 1.1 of Adélie Linux.</para> + </example> + </para> + </formalpara> + </section> <section id="repository"> <title><literal>repository</literal></title> <formalpara id="repository.name"> |