[install-guide/f21-branch: 6/32] Removing most TODOs from Kickstart Syntax Reference
pbokoc
pbokoc at fedoraproject.org
Tue Dec 9 17:30:55 UTC 2014
commit 47cedcfea2c2c20f40473faa0857097658b49aab
Author: Petr Bokoc <pbokoc at redhat.com>
Date: Sun Dec 7 20:10:06 2014 +0100
Removing most TODOs from Kickstart Syntax Reference
en-US/Kickstart_Syntax_Reference.xml | 49 +++++++++++-----------------------
1 files changed, 16 insertions(+), 33 deletions(-)
---
diff --git a/en-US/Kickstart_Syntax_Reference.xml b/en-US/Kickstart_Syntax_Reference.xml
index f50060b..3b6a943 100644
--- a/en-US/Kickstart_Syntax_Reference.xml
+++ b/en-US/Kickstart_Syntax_Reference.xml
@@ -232,7 +232,7 @@
<term><command>nfs</command></term>
<listitem>
<para>
- Install from an <systemitem class="protocol">NFS</systemitem> server specified. <remark>TODO: link to the PXE chapter's section on preparing install source on nfs</remark>
+ Install from an <systemitem class="protocol">NFS</systemitem> server specified. The NFS server must be exporting the full installation ISO image (such as the &PRODUCT; Server DVD) or its extracted contents.
</para>
<programlisting>
<command>install</command>
@@ -472,7 +472,7 @@
</listitem>
</itemizedlist>
<para>
- For a description of the available partition schemes, see <remark>TODO: xref to a list of available auto partitioning schemes</remark>
+ The created partitioning scheme will follow the recommended scheme described at <xref linkend="sect-installation-gui-manual-partitioning-recommended" />.
</para>
</listitem>
</varlistentry>
@@ -537,12 +537,12 @@
</programlisting>
<important>
<para>
- You should always use a password to protect your boot loader. An unprotected boot loader can allow a potential attacker to modify the system's boot options and gain unauthorized access to the system.
+ You should always use a password to protect your boot loader. An unprotected boot loader can allow a potential attacker to modify the system's boot options and gain unauthorized access to the system.
</para>
</important>
<important>
<para>
- Some systems require a special partition for installing the boot loader. The type and size of this partition depends on whether the disk you are installing the boot loader to uses the <firstterm>Master Boot Record</firstterm> (MBR) or a <firstterm>GUID Partition Table</firstterm> (GPT) schema. For more information, see <remark>TODO: link to a section that deals with boot loaders and EFI/BIOSBoot</remark>
+ Some systems require a special partition for installing the boot loader. The type and size of this partition depends on whether the disk you are installing the boot loader to uses the <firstterm>Master Boot Record</firstterm> (MBR) or a <firstterm>GUID Partition Table</firstterm> (GPT) schema. For more information, see <xref linkend="sect-installation-gui-storage-partitioning-bootloader" />.
</para>
</important>
<variablelist>
@@ -1115,7 +1115,7 @@
The size assigned will be equivalent to the swap space assigned by <option>--recommended</option> plus the amount of RAM on your system.
</para>
<para>
- For the swap sizes assigned by these commands, see <remark>todo: xref to a section about swap sizes</remark>
+ For the swap sizes assigned by these commands, see the section describing swap in <xref linkend="sect-installation-gui-manual-partitioning-recommended" />.
</para>
</listitem>
</varlistentry>
@@ -1150,7 +1150,7 @@
<term><option>--fstype=</option></term>
<listitem>
<para>
- Sets the file system type for the logical volume. Valid values are <literal>xfs</literal>, <literal>ext2</literal>, <literal>ext3</literal>, <literal>ext4</literal>, <literal>swap</literal>, and <literal>vfat</literal>. For information about file system types, see <remark>TODO: xref to info about fs types</remark>
+ Sets the file system type for the logical volume. Valid values are <literal>xfs</literal>, <literal>ext2</literal>, <literal>ext3</literal>, <literal>ext4</literal>, <literal>swap</literal>, and <literal>vfat</literal>. See <xref linkend="sect-installation-gui-manual-partitioning-filesystems" /> for information about available file systems.
</para>
</listitem>
</varlistentry>
@@ -1214,7 +1214,7 @@
<term><option>--recommended</option></term>
<listitem>
<para>
- Use this option when creating a <systemitem>swap</systemitem> logical volume to determine the size of this volume automatically, based on your system's hardware. For details about the recommended scheme, see <remark>TODO: xref to section with partitioning recommendations</remark>
+ Use this option when creating a <systemitem>swap</systemitem> logical volume to determine the size of this volume automatically, based on your system's hardware. For details about the recommended scheme, see <xref linkend="sect-installation-gui-manual-partitioning-recommended" />.
</para>
</listitem>
</varlistentry>
@@ -1379,7 +1379,7 @@
The size assigned will be equivalent to the swap space assigned by <option>--recommended</option> plus the amount of RAM on your system.
</para>
<para>
- For the swap sizes assigned by these commands, see <remark>todo: xref to a section about swap sizes</remark>
+ For the swap sizes assigned by these commands, see the section describing swap in <xref linkend="sect-installation-gui-manual-partitioning-recommended" />.
</para>
</listitem>
</varlistentry>
@@ -1426,7 +1426,7 @@
</para>
<important>
<para>
- If the <option>--size</option> value is too small, the installation will fail. Set the <option>--size</option> value as the minimum amount of space you require. For size recommendations, see <remark>TODO: xref to recommended partitioning scheme</remark>.
+ If the <option>--size</option> value is too small, the installation will fail. Set the <option>--size</option> value as the minimum amount of space you require. For size recommendations, see <xref linkend="sect-installation-gui-manual-partitioning-recommended" />.
</para>
</important>
</listitem>
@@ -1536,7 +1536,7 @@
<term><option>--fstype=</option></term>
<listitem>
<para>
- Sets the file system type for the partition. Valid values are <literal>xfs</literal>, <literal>ext2</literal>, <literal>ext3</literal>, <literal>ext4</literal>, <literal>swap</literal>, <literal>vfat</literal>, <literal>efi</literal> and <literal>biosboot</literal>. For information about supported file systems, see <remark>TODO: xref to something about supported fs types</remark>
+ Sets the file system type for the partition. Valid values are <literal>xfs</literal>, <literal>ext2</literal>, <literal>ext3</literal>, <literal>ext4</literal>, <literal>swap</literal>, <literal>vfat</literal>, <literal>efi</literal> and <literal>biosboot</literal>. For information about supported file systems, see <xref linkend="sect-installation-gui-manual-partitioning-filesystems" />.
</para>
</listitem>
</varlistentry>
@@ -1563,7 +1563,7 @@
<term><option>--recommended</option></term>
<listitem>
<para>
- Determine the size of the partition automatically. For details about the recommended scheme, see <remark>TODO: xref to something about recommended partitioning scheme</remark>
+ Determine the size of the partition automatically. For details about the recommended scheme, see <xref linkend="sect-installation-gui-manual-partitioning-recommended" />.
</para>
</listitem>
</varlistentry>
@@ -1642,7 +1642,7 @@
<term><option>--level=</option></term>
<listitem>
<para>
- RAID level to use (<literal>0</literal>, <literal>1</literal>, <literal>4</literal>, <literal>5</literal>, <literal>6</literal>, or <literal>10</literal>). <remark>TODO: xref to the section that describes raid levels</remark>
+ RAID level to use (<literal>0</literal>, <literal>1</literal>, <literal>4</literal>, <literal>5</literal>, <literal>6</literal>, or <literal>10</literal>). See <xref linkend="sect-installation-gui-manual-partitioning-filesystems" /> for information about various RAID types and their requirements.
</para>
</listitem>
</varlistentry>
@@ -1674,7 +1674,7 @@
<term><option>--fstype=</option></term>
<listitem>
<para>
- Sets the file system type for the partition. Valid values are <literal>xfs</literal>, <literal>ext2</literal>, <literal>ext3</literal>, <literal>ext4</literal>, <literal>swap</literal>, <literal>vfat</literal>, <literal>efi</literal> and <literal>biosboot</literal>. For information about supported file systems, see <remark>TODO: xref to something about supported fs types</remark>
+ Sets the file system type for the partition. Valid values are <literal>xfs</literal>, <literal>ext2</literal>, <literal>ext3</literal>, <literal>ext4</literal>, <literal>swap</literal>, <literal>vfat</literal>, <literal>efi</literal> and <literal>biosboot</literal>. For information about supported file systems, see <xref linkend="sect-installation-gui-manual-partitioning-filesystems" />.
</para>
</listitem>
</varlistentry>
@@ -1920,7 +1920,7 @@
<section id="sect-kickstart-commands-firewall">
<title>firewall (optional) - Configure Firewall</title>
<para>
- Specify the firewall configuration for the installed system. <remark>TODO: link to the Firewall guide once we have one</remark>
+ Specify the firewall configuration for the installed system.
</para>
<programlisting>
<command>firewall --enabled | --disabled <replaceable>device</replaceable> [--trust= | --ssh | --smtp | --http | --ftp | --port= | --service=]</command>
@@ -2882,9 +2882,9 @@
</section>
<section id="sect-kickstart-commands-selinux">
- <title>selinux (optional) - Configure SELinux</title>
+ <title>selinux (optional) - Configu re SELinux</title>
<para>
- Sets the state of SELinux on the installed system. The default policy is <systemitem>enforcing</systemitem>. For more information regarding SELinux in &PRODUCT;, see <remark>TODO: link to wherever we document SELinux now</remark>
+ Sets the state of SELinux on the installed system. The default policy is <systemitem>enforcing</systemitem>. For more information regarding SELinux in &PRODUCT;, see the <citetitle>&PRODUCT; SELinux User's and Administrator's Guide</citetitle>, available at <ulink url="http://docs.fedoraproject.org/" />.
</para>
<programlisting>
<command>selinux [--disabled|--enforcing|--permissive]</command>
@@ -3256,23 +3256,6 @@
This section contains commands which control the system's behavior immediately after the installation finishes.
</para>
- <section id="sect-kickstart-commands-eula">
- <title>eula (optional) - Accept the License Agreement</title>
- <para>
- Use this option to accept the <firstterm>End User License Agreement</firstterm> (EULA) without user interaction. Specifying this option prevents <application>Initial Setup</application> from prompting you to accept the license agreement after you finish the installation and reboot the system for the first time. See <xref linkend="sect-initial-setup" /> for more information.
- </para>
- <variablelist>
- <varlistentry>
- <term><option>--agreed</option></term>
- <listitem>
- <para>
- Accept the EULA. This option must always be used, otherwise the <command>eula</command> command is meaningless. <remark>TODO: Does this even make sense on Fedora? Does initial-setup have an EULA in it?</remark>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </section>
-
<section id="sect-kickstart-commands-firstboot">
<title>firstboot (optional) - Enable or Disable Initial Setup</title>
<para>
More information about the docs-commits
mailing list