summaryrefslogtreecommitdiff
path: root/devel
diff options
context:
space:
mode:
authorA. Wilcox <AWilcox@Wilcox-Tech.com>2020-06-13 15:52:16 -0500
committerA. Wilcox <AWilcox@Wilcox-Tech.com>2020-06-13 15:52:16 -0500
commit0449dbe11ce3413914ba49b1b8974d2241bad6e4 (patch)
tree80cd5d17403dd1dad0fc7fa975bc52830fa95e74 /devel
parent95d1635be3f65ac35f07e8f33f51af2912ba1ec2 (diff)
downloadhorizon-0449dbe11ce3413914ba49b1b8974d2241bad6e4.tar.gz
horizon-0449dbe11ce3413914ba49b1b8974d2241bad6e4.tar.bz2
horizon-0449dbe11ce3413914ba49b1b8974d2241bad6e4.tar.xz
horizon-0449dbe11ce3413914ba49b1b8974d2241bad6e4.zip
devel: script: Document the 'version' key
Diffstat (limited to 'devel')
-rw-r--r--devel/script/2_keys.xml31
-rw-r--r--devel/script/script.xml10
2 files changed, 36 insertions, 5 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">
diff --git a/devel/script/script.xml b/devel/script/script.xml
index 56eba3a..f8c1a65 100644
--- a/devel/script/script.xml
+++ b/devel/script/script.xml
@@ -11,15 +11,15 @@
<authorgroup>
<author><firstname>A.</firstname><surname>Wilcox</surname><affiliation><orgname>Adélie Linux</orgname></affiliation></author>
</authorgroup>
- <edition>Specification for HorizonScript (Horizon release 1.0): Draft</edition>
- <pubdate>2019</pubdate>
+ <edition>Specification for HorizonScript (Horizon release 1.0)</edition>
+ <pubdate>2020-06-13</pubdate>
<copyright>
- <year>2019</year>
+ <year>2019</year><year>2020</year>
<holder>Adélie Linux</holder>
</copyright>
<legalnotice>
- <para>Development documentation for Project Horizon is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.</para>
- <para>You should have received a copy of the license along with this work. If not, see <ulink url="https://creativecommons.org/licenses/by-nc-sa/4.0/"><citetitle>the Creative Commons Web site</citetitle></ulink>.</para>
+ <para>Development documentation for Project Horizon is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.</para>
+ <para>You should have received a copy of the license along with this work. If not, see <ulink url="https://creativecommons.org/licenses/by-sa/4.0/"><citetitle>the Creative Commons Web site</citetitle></ulink>.</para>
</legalnotice>
<abstract><para>This document describes the file format of HorizonScript. HorizonScript is the input file used for Project Horizon, the installation system for Adélie Linux.</para></abstract>
</bookinfo>