summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorA. Wilcox <AWilcox@Wilcox-Tech.com>2020-06-13 17:00:33 -0500
committerA. Wilcox <AWilcox@Wilcox-Tech.com>2020-06-13 17:00:33 -0500
commitbf0a535dc40bcd052efdc1fa0d56d3fc35800021 (patch)
tree3de92d50f2336eaa5f4f426eb8d99098d268098e
parent0449dbe11ce3413914ba49b1b8974d2241bad6e4 (diff)
downloadhorizon-bf0a535dc40bcd052efdc1fa0d56d3fc35800021.tar.gz
horizon-bf0a535dc40bcd052efdc1fa0d56d3fc35800021.tar.bz2
horizon-bf0a535dc40bcd052efdc1fa0d56d3fc35800021.tar.xz
horizon-bf0a535dc40bcd052efdc1fa0d56d3fc35800021.zip
devel: script: Document new 'bootloader' key
-rw-r--r--devel/script/2_keys.xml31
1 files changed, 31 insertions, 0 deletions
diff --git a/devel/script/2_keys.xml b/devel/script/2_keys.xml
index 42290ea..021d22b 100644
--- a/devel/script/2_keys.xml
+++ b/devel/script/2_keys.xml
@@ -647,6 +647,37 @@ signingkey https://packages/builder@ourcompany.net.pub
</para>
</formalpara>
</section>
+ <section id="bootloader">
+ <title><literal>bootloader</literal></title>
+ <formalpara id="bootloader.name">
+ <title>Name</title>
+ <para><literal>bootloader</literal></para>
+ </formalpara>
+ <formalpara id="bootloader.purpose">
+ <title>Purpose</title>
+ <para>The <literal>bootloader</literal> key specifies the bootloader configuration for the target computer.</para>
+ </formalpara>
+ <formalpara id="bootloader.format">
+ <title>Format</title>
+ <para>The <literal>bootloader</literal> key is a string and/or boolean value. If the value is <literal>false</literal>, no bootloader will be installed on the target computer and boot configuration must be performed externally. If the value is <literal>true</literal>, Horizon will install the platform's preferred bootloader. If the value is a string value, Horizon will attempt to install the specified bootloader. If the string value does not correspond to a bootloader available for the target computer, script execution will fail.</para>
+ </formalpara>
+ <formalpara id="bootloader.default">
+ <title>Default</title>
+ <para>If no <literal>bootloader</literal> key is specified, the system will behave as if <literal>false</literal> was given.</para>
+ </formalpara>
+ <formalpara id="bootloader.example">
+ <title>Example</title>
+ <para>
+ <example>
+ <title>The <literal>bootloader</literal> Key</title>
+ <programlisting>
+bootloader true
+ </programlisting>
+ <para>This will configure the target computer with the platform's preferred bootloader.</para>
+ </example>
+ </para>
+ </formalpara>
+ </section>
<section id="username">
<title><literal>username</literal></title>
<formalpara id="username.name">