[install-guide] Added Create Btrfs section and restructured XML of Create Software RAID section to correspond
Jack Reed
jjr at fedoraproject.org
Tue Jan 15 00:23:04 UTC 2013
commit e8e670954b11163fbd7b546915da9ec1dd6fe67d
Author: Jack Reed <jreed at redhat.com>
Date: Tue Jan 15 10:22:30 2013 +1000
Added Create Btrfs section and restructured XML of Create Software RAID section to correspond
...titions-section-2-itemizedlist-1-listitem-0.xml | 13 +-----
en-US/Create_Btrfs-common-para-1.xml | 9 +++
en-US/Create_Btrfs-common-para-2.xml | 9 +++
en-US/Create_Btrfs-common-procedure.xml | 51 +++++++++++++++++++
en-US/Create_Btrfs-common-title-1.xml | 7 +++
en-US/Create_Btrfs-common-variablelist-1.xml | 14 +++++
en-US/Create_Btrfs-x86.xml | 53 ++++++++++++++++++++
...Software_RAID-Btrfs-common-procedure-para-1.xml | 9 +++
...Software_RAID-Btrfs-common-procedure-para-2.xml | 9 +++
...Software_RAID-Btrfs-common-procedure-para-4.xml | 9 +++
...Software_RAID-Btrfs-common-procedure-para-5.xml | 9 +++
en-US/Create_Software_RAID-common-procedure.xml | 33 +++++++-----
en-US/Disk_Partitioning-x86.xml | 3 +-
en-US/images/diskpartitioning/btrfs.png | Bin 0 -> 28077 bytes
14 files changed, 202 insertions(+), 26 deletions(-)
---
diff --git a/en-US/Adding_Partitions-section-2-itemizedlist-1-listitem-0.xml b/en-US/Adding_Partitions-section-2-itemizedlist-1-listitem-0.xml
index 0b60d55..f06017e 100644
--- a/en-US/Adding_Partitions-section-2-itemizedlist-1-listitem-0.xml
+++ b/en-US/Adding_Partitions-section-2-itemizedlist-1-listitem-0.xml
@@ -5,17 +5,6 @@
]>
<listitem>
<para>
- <guilabel>Btrfs</guilabel> — Btrfs is under development as a file system with several device-like features, so is presented in the installer as a type of partition. It is capable of addressing and managing more files, larger files, and larger volumes than the ext2, ext3, and ext4 file systems. Btrfs is designed to make the file system tolerant of errors, and to facilitate the detection and repair of errors when they occur. It uses checksums to ensure the validity of data and metadata, and maintains snapshots of the file system that can be used for backup or repair.
+ <guilabel>Btrfs</guilabel> — Btrfs is under development as a file system with several device-like features, so is presented in the installer as a type of partition. It is capable of addressing and managing more files, larger files, and larger volumes than the ext2, ext3, and ext4 file systems. To create a Btrfs volume and read more information, refer to <xref linkend="Create_Btrfs-x86" />.
</para>
- <warning>
- <title>Btrfs is still experimental</title>
- <para>
- Fedora &PRODVER; includes Btrfs as a technology preview to allow you to experiment with this file system. You should not choose Btrfs for partitions that will contain valuable data or that are essential for the operation of important systems.
- </para>
- </warning>
- <important>
- <para>
- Placing <filename>/boot</filename> on a Btrfs subvolume may lead to instability and is not recommended.
- </para>
- </important>
</listitem>
\ No newline at end of file
diff --git a/en-US/Create_Btrfs-common-para-1.xml b/en-US/Create_Btrfs-common-para-1.xml
new file mode 100644
index 0000000..d578225
--- /dev/null
+++ b/en-US/Create_Btrfs-common-para-1.xml
@@ -0,0 +1,9 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<para>
+ <firstterm>Btrfs</firstterm> is a type of file system, but has several features characteristic of a storage device. It is designed to make the file system tolerant of errors, and to facilitate the detection and repair of errors when they occur. It uses checksums to ensure the validity of data and metadata, and maintains snapshots of the file system that can be used for backup or repair.
+</para>
+
diff --git a/en-US/Create_Btrfs-common-para-2.xml b/en-US/Create_Btrfs-common-para-2.xml
new file mode 100644
index 0000000..2e670b3
--- /dev/null
+++ b/en-US/Create_Btrfs-common-para-2.xml
@@ -0,0 +1,9 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<para>
+ During manual partitioning, you will create Btrfs subvolumes rather than volumes. The installer then automatically creates a Btrfs volume to contain these subvolumes. The sizes reported for each Btrfs mount point in the left pane of the <guilabel>Manual Partitioning</guilabel> screen will be identical because they reflect the total size of the volume rather than each individual subvolume.
+</para>
+
diff --git a/en-US/Create_Btrfs-common-procedure.xml b/en-US/Create_Btrfs-common-procedure.xml
new file mode 100644
index 0000000..f83ac7c
--- /dev/null
+++ b/en-US/Create_Btrfs-common-procedure.xml
@@ -0,0 +1,51 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<procedure>
+ <step>
+ <para>
+ Create a partition as described in <xref linkend="Adding_Partitions-x86" />. Configuring this partition will configure the Btrfs subvolume.
+ </para>
+ </step>
+
+ <step>
+ <para>
+ Click the <guilabel>Device Type</guilabel> dropdown menu and select <guilabel>BTRFS</guilabel>.
+ </para>
+ </step>
+
+ <step>
+ <para>
+ Two checkboxes will appear beneath the <guilabel>File System</guilabel> dropdown menu, which is grayed out for Btrfs. If you want to add a RAID level to the subvolume, choose one by checking the required boxes. If not, skip to step 5.
+ </para>
+
+ <xi:include href="Create_Software_RAID-Btrfs-common-procedure-para-1.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <!-- Next to each checkbox, any disk space that will be gained or lost -->
+
+ <xi:include href="Create_Software_RAID-Btrfs-common-procedure-para-2.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <!-- The checkboxes required for each RAID level are: -->
+
+ <xi:include href="Create_Btrfs-common-variablelist-1.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <!-- Optimized performance (stripe) --> <xi:include href="Create_Software_RAID-common-note-1.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <!-- If both Redundancy (mirror) and Optimized performance (stripe) are checked -->
+ </step>
+ <step>
+
+ <para>
+ Keeping the partition selected in the left-hand pane, select the configuration button below the pane to open the <guilabel>Configure Mount Point</guilabel> dialog. Select which disks will be included as part of the RAID on the subvolume and click <guibutton>Select</guibutton>.
+ </para>
+
+ <xi:include href="Create_Software_RAID-Btrfs-common-procedure-para-4.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <!-- If fewer disks are included than the specified RAID level needs -->
+
+ </step>
+
+ <step>
+ <xi:include href="Create_Software_RAID-Btrfs-common-procedure-para-5.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <!-- Click Apply Changes to save your changes -->
+ </step>
+
+ </procedure>
+
diff --git a/en-US/Create_Btrfs-common-title-1.xml b/en-US/Create_Btrfs-common-title-1.xml
new file mode 100644
index 0000000..df2b253
--- /dev/null
+++ b/en-US/Create_Btrfs-common-title-1.xml
@@ -0,0 +1,7 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE title PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<title> Create a Btrfs subvolume</title>
+
diff --git a/en-US/Create_Btrfs-common-variablelist-1.xml b/en-US/Create_Btrfs-common-variablelist-1.xml
new file mode 100644
index 0000000..c9d0897
--- /dev/null
+++ b/en-US/Create_Btrfs-common-variablelist-1.xml
@@ -0,0 +1,14 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE variablelist PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<variablelist>
+
+<xi:include href="Create_Software_RAID-common-varlistentry-1.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+<!-- Optimized performance (stripe) --> <xi:include href="Create_Software_RAID-common-varlistentry-2.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+<!-- Redundancy (mirror) --> <xi:include href="Create_Software_RAID-common-varlistentry-6.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+<!-- Redundancy (mirror) and Optimized performance (stripe) -->
+
+</variablelist>
+
diff --git a/en-US/Create_Btrfs-x86.xml b/en-US/Create_Btrfs-x86.xml
new file mode 100644
index 0000000..7ec5625
--- /dev/null
+++ b/en-US/Create_Btrfs-x86.xml
@@ -0,0 +1,53 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<section id="Create_Btrfs-x86">
+ <xi:include href="Create_Btrfs-common-title-1.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <!-- Create a Btrfs Volume -->
+
+ <warning>
+ <title>Btrfs is still experimental</title>
+ <para>
+ Fedora &PRODVER; includes Btrfs as a technology preview to allow you to experiment with this file system. You should not choose Btrfs for partitions that will contain valuable data or that are essential for the operation of important systems.
+ </para>
+ </warning>
+
+ <xi:include href="Create_Btrfs-common-para-1.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <!-- Logical Volume Management (LVM) presents a simple logical view of underlying physical storage space --> <xi:include href="Create_Btrfs-common-para-2.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <!-- During manual partitioning, you will create Btrfs subvolumes rather than volumes. -->
+
+ <figure float="0">
+ <title>Configure a Btrfs volume</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/diskpartitioning/btrfs.png" format="PNG" width="444" />
+ </imageobject>
+ <textobject>
+ <para>
+ The area of the Manual Partitioning screen for configuring a Btrfs subvolume.
+ </para>
+
+ </textobject>
+
+ </mediaobject>
+
+ </figure>
+
+ <para>
+ To create a Btrfs subvolume:
+ </para>
+
+ <xi:include href="Create_Btrfs-common-procedure.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <!-- Create a partition as described in -->
+
+ <important>
+ <para>
+ Placing <filename>/boot</filename> on a Btrfs subvolume may lead to instability and is not recommended.
+ </para>
+ </important>
+
+</section>
+
+
diff --git a/en-US/Create_Software_RAID-Btrfs-common-procedure-para-1.xml b/en-US/Create_Software_RAID-Btrfs-common-procedure-para-1.xml
new file mode 100644
index 0000000..39cbcfc
--- /dev/null
+++ b/en-US/Create_Software_RAID-Btrfs-common-procedure-para-1.xml
@@ -0,0 +1,9 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<para>
+ Next to each checkbox, any disk space that will be gained or lost by selecting that option will be displayed in red. Certain boxes may be grayed out and labeled <guilabel>not enough disks</guilabel> if that RAID level cannot be achieved with the available disks.
+</para>
+
diff --git a/en-US/Create_Software_RAID-Btrfs-common-procedure-para-2.xml b/en-US/Create_Software_RAID-Btrfs-common-procedure-para-2.xml
new file mode 100644
index 0000000..6723d27
--- /dev/null
+++ b/en-US/Create_Software_RAID-Btrfs-common-procedure-para-2.xml
@@ -0,0 +1,9 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<para>
+ The checkboxes required for each RAID level are:
+</para>
+
diff --git a/en-US/Create_Software_RAID-Btrfs-common-procedure-para-4.xml b/en-US/Create_Software_RAID-Btrfs-common-procedure-para-4.xml
new file mode 100644
index 0000000..bf02205
--- /dev/null
+++ b/en-US/Create_Software_RAID-Btrfs-common-procedure-para-4.xml
@@ -0,0 +1,9 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<para>
+ If fewer disks are included than the specified RAID level needs, a yellow notification bar at the bottom of the screen will inform you that <guilabel>Device reconfiguration failed</guilabel>. Clicking this warning prompts a dialog informing you how many disks are required.
+</para>
+
diff --git a/en-US/Create_Software_RAID-Btrfs-common-procedure-para-5.xml b/en-US/Create_Software_RAID-Btrfs-common-procedure-para-5.xml
new file mode 100644
index 0000000..0cf9a7a
--- /dev/null
+++ b/en-US/Create_Software_RAID-Btrfs-common-procedure-para-5.xml
@@ -0,0 +1,9 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+<!ENTITY % BOOK_ENTITIES SYSTEM "Installation_Guide.ent">
+%BOOK_ENTITIES;
+]>
+<para>
+ Click <guibutton>Apply Changes</guibutton> to save your changes, and either continue with another partition or click <guibutton>Finish Partitioning</guibutton> to return to the Installation Summary Menu.
+</para>
+
diff --git a/en-US/Create_Software_RAID-common-procedure.xml b/en-US/Create_Software_RAID-common-procedure.xml
index 1950a41..8e7f936 100644
--- a/en-US/Create_Software_RAID-common-procedure.xml
+++ b/en-US/Create_Software_RAID-common-procedure.xml
@@ -18,32 +18,39 @@
<step>
<para>
- A group of checkboxes will appear beneath the <guilabel>File System</guilabel> dropdown menu, which is grayed out for RAID. Choose the RAID level of the device by checking the required boxes. The level will be displayed at the right when these boxes have been checked.
- </para>
- <para>
- Next to each checkbox, any disk space that will be gained or lost by selecting that option will be displayed in red. Certain boxes may be grayed out and labeled <guilabel>not enough disks</guilabel> if that RAID level cannot be achieved with the available disks.
+ Click the <guilabel>File System</guilabel> dropdown menu and select your preferred file system type (refer to <xref linkend="s3-diskpartitioning-file-x86" />.
</para>
+ </step>
+
+ <step>
<para>
- The checkboxes required for each RAID level are:
- </para>
+ A group of checkboxes will have appeared beneath the <guilabel>File System</guilabel> dropdown menu. Choose the RAID level of the device by checking the required boxes. The level will be displayed at the right when these boxes have been checked.
+ </para>
+
+ <xi:include href="Create_Software_RAID-Btrfs-common-procedure-para-1.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <!-- Next to each checkbox, any disk space that will be gained or lost -->
+
+ <xi:include href="Create_Software_RAID-Btrfs-common-procedure-para-2.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <!-- The checkboxes required for each RAID level are: -->
<xi:include href="Create_Software_RAID-common-variablelist-1.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<!-- Optimized performance (stripe) --> <xi:include href="Create_Software_RAID-common-note-1.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<!-- If both Redundancy (mirror) and Optimized performance (stripe) are checked -->
</step>
<step>
+
<para>
- Keeping the partition selected in the left-hand pane, select the configuration button below the pane to open the <guilabel>Configure Mount Point</guilabel> dialog. Select which disks will be included in the RAID device and click <guibutton>Select</guibutton>.
- </para>
- <para>
- If fewer disks are included than the specified RAID level needs, a yellow notification bar at the bottom of the screen will inform you that <guilabel>Device reconfiguration failed</guilabel>. Clicking this warning prompts a dialog informing you how many disks are required.
+ Keeping the partition selected in the left-hand pane, select the configuration button below the pane to open the <guilabel>Configure Mount Point</guilabel> dialog. Select which disks will be included in the RAID device and click <guibutton>Select</guibutton>.
</para>
+
+ <xi:include href="Create_Software_RAID-Btrfs-common-procedure-para-4.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <!-- If fewer disks are included than the specified RAID level needs -->
+
</step>
<step>
- <para>
- Click <guibutton>Apply Changes</guibutton> to save your changes, and either continue with another partition or click <guibutton>Finish Partitioning</guibutton> to return to the Installation Summary Menu.
- </para>
+ <xi:include href="Create_Software_RAID-Btrfs-common-procedure-para-5.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <!-- Click Apply Changes to save your changes -->
</step>
</procedure>
diff --git a/en-US/Disk_Partitioning-x86.xml b/en-US/Disk_Partitioning-x86.xml
index f2251ff..15c1d19 100644
--- a/en-US/Disk_Partitioning-x86.xml
+++ b/en-US/Disk_Partitioning-x86.xml
@@ -27,7 +27,8 @@
<!-- The Manual Partitioning screen initially features... --> <xi:include href="Adding_Partitions-x86.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<!-- Adding Partitions --> <xi:include href="Create_Software_RAID-x86.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<!-- Create Software RAID --> <xi:include href="Create_LVM-x86.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
- <!-- Create LVM Logical Volume --> <xi:include href="Disk_Partitioning_Scheme-x86.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <!-- Create LVM Logical Volume --> <xi:include href="Create_Btrfs-x86.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <!-- Create a Btrfs Volume --> <xi:include href="Disk_Partitioning_Scheme-x86.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
<!-- Recommended Partitioning Scheme -->
</section>
diff --git a/en-US/images/diskpartitioning/btrfs.png b/en-US/images/diskpartitioning/btrfs.png
new file mode 100644
index 0000000..e55033e
Binary files /dev/null and b/en-US/images/diskpartitioning/btrfs.png differ
More information about the docs-commits
mailing list