doc-el commit 843:8e7f81d3581f - gjournal-desktop: Merge the lat...
freebsd-doc-el at lists.hellug.gr
freebsd-doc-el at lists.hellug.gr
Sun Sep 28 17:11:55 EEST 2008
changeset: 843:8e7f81d3581f
user: Manolis Kiagias <sonicy at otenet.gr>
date: 2008-09-28 13:36 +0300
details: http://hg.hellug.gr/freebsd/doc-el/?cmd=changeset;node=8e7f81d3581f
description:
gjournal-desktop: Merge the latest version from ncvs
diffs (truncated from 562 to 300 lines):
diff -r 208bf6dccd00 -r 8e7f81d3581f en_US.ISO8859-1/articles/gjournal-desktop/article.sgml
--- a/en_US.ISO8859-1/articles/gjournal-desktop/article.sgml Sun Sep 28 00:43:31 2008 +0300
+++ b/en_US.ISO8859-1/articles/gjournal-desktop/article.sgml Sun Sep 28 13:36:04 2008 +0300
@@ -13,22 +13,22 @@
<article lang="en">
<articleinfo>
- <title>Implementing UFS journaling on a desktop PC</title>
+ <title>Implementing UFS Journaling on a Desktop PC</title>
<author>
<firstname>Manolis</firstname>
<surname>Kiagias</surname>
<affiliation>
- <address><email>sonicy at otenet.gr</email></address>
+ <address><email>manolis at FreeBSD.org</email></address>
</affiliation>
</author>
<copyright>
<year>2008</year>
- <holder role="mailto:sonicy at otenet.gr">Manolis Kiagias</holder>
+ <holder role="mailto:manolis at FreeBSD.org">Manolis Kiagias</holder>
</copyright>
- <releaseinfo>$FreeBSD: doc/en_US.ISO8859-1/articles/gjournal-desktop/article.sgml,v 1.2 2008/04/28 15:56:20 gabor Exp $</releaseinfo>
+ <releaseinfo>$FreeBSD: doc/en_US.ISO8859-1/articles/gjournal-desktop/article.sgml,v 1.3 2008/09/26 11:44:17 pgj Exp $</releaseinfo>
<legalnotice id="trademarks" role="trademarks">
&tm-attrib.freebsd;
@@ -36,16 +36,16 @@
</legalnotice>
<abstract>
- <para>A journaling filesystem uses a log to record all transactions
- that take place in the filesystem, and preserves its integrity in the
+ <para>A journaling file system uses a log to record all transactions
+ that take place in the file system, and preserves its integrity in the
event of a system crash or power failure. Although it is still
possible to lose unsaved changes to files, journaling almost
- completely eliminates the possibility of filesystem corruption caused
+ completely eliminates the possibility of file system corruption caused
by an unclean shutdown. It also shortens to a minimum the time
- required for after-failure filesystem checking. Although the UFS
- filesystem employed by &os; does not implement journaling itself,
- the new journal class of the GEOM framework in &os; 7.X can be
- used to provide filesystem independent journaling. This article
+ required for after-failure file system checking. Although the UFS
+ file system employed by &os; does not implement journaling itself,
+ the new journal class of the GEOM framework in &os; 7.<replaceable>X</replaceable> can be
+ used to provide file system independent journaling. This article
explains how to implement UFS journaling on a typical desktop PC
scenario.</para>
</abstract>
@@ -57,15 +57,15 @@
<para>While professional servers are usually well protected from
unforeseen shutdowns, the typical desktop is at the mercy of power
failures, accidental resets, and other user related incidents that can
- lead to unclean shutdowns. Soft updates usually protect the filesystem
+ lead to unclean shutdowns. Soft Updates usually protect the file system
efficiently in such cases, although most of the times a lengthy
- background check is required. On rare occasions, filesystem corruption
+ background check is required. On rare occasions, file system corruption
reaches a point where user intervention is required and data may be
lost.</para>
<para>The new journaling capability provided by GEOM can greatly assist
in such scenarios, by virtually eliminating the time required for
- filesystem checking, and ensuring that the filesystem is quickly
+ file system checking, and ensuring that the file system is quickly
restored to a consistent state.</para>
<para>This article describes a procedure for implementing UFS journaling
@@ -88,7 +88,7 @@
</listitem>
<listitem>
- <para>How to convert your existing filesystems to utilize journaling,
+ <para>How to convert your existing file systems to utilize journaling,
and what options to use in <filename>/etc/fstab</filename> to mount
them.</para>
</listitem>
@@ -128,59 +128,59 @@
</sect1>
<sect1 id="understanding-journaling">
- <title>Understanding journaling in &os;</title>
+ <title>Understanding Journaling in &os;</title>
- <para>The journaling provided by GEOM in &os; 7.X is not filesystem
- specific (unlike for example the ext3 filesystem in &linux;) but is
+ <para>The journaling provided by GEOM in &os; 7.<replaceable>X</replaceable> is not file system
+ specific (unlike for example the ext3 file system in &linux;) but is
functioning at the block level. Though this means it can be applied
- to different filesystems, for &os; 7.0-RELEASE, it can only be used
+ to different file systems, for &os; 7.0-RELEASE, it can only be used
on UFS2.</para>
<para>This functionality is provided by loading the
<filename>geom_journal.ko</filename> module into the kernel (or
building it into a custom kernel) and using the
- <command>gjournal</command> command to configure the filesystems.
- In general, you would like to journal large filesystems, like
+ <command>gjournal</command> command to configure the file systems.
+ In general, you would like to journal large file systems, like
<filename>/usr</filename>. You will need however (see the following
section) to reserve some free disk space.</para>
- <para>When a filesystem is journaled, some disk space is needed to keep
+ <para>When a file system is journaled, some disk space is needed to keep
the journal itself. The disk space that holds the actual data is
referred to as the <emphasis>data provider</emphasis>, while the one
that holds the journal is referred to as the
<emphasis>journal provider</emphasis>. The data and journal providers
need to be on different partitions when journaling an existing
- (non empty) partition. When journaling a new partition, you have the
+ (non-empty) partition. When journaling a new partition, you have the
option to use a single provider for both data and journal. In any case,
the <command>gjournal</command> command combines both providers to
- create the final journaled filesystem. For example:</para>
+ create the final journaled file system. For example:</para>
<itemizedlist>
<listitem>
- <para>You wish to journal your <filename>/usr</filename> filesystem,
- stored in <filename role="device">/dev/ad0s1f</filename> (which
+ <para>You wish to journal your <filename>/usr</filename> file system,
+ stored in <filename class="devicefile">/dev/ad0s1f</filename> (which
already contains data).</para>
</listitem>
<listitem>
<para>You reserved some free disk space in a partition in
- <filename role="device">/dev/ad0s1g</filename>.</para>
+ <filename class="devicefile">/dev/ad0s1g</filename>.</para>
</listitem>
<listitem>
<para>Using <command>gjournal</command>, a new <filename
- role="device">/dev/ad0s1f.journal</filename> device is created
- where <filename role="device">/dev/ad0s1f</filename> is the data
- provider, and <filename role="device">/dev/ad0s1g</filename> is
+ class="devicefile">/dev/ad0s1f.journal</filename> device is created
+ where <filename class="devicefile">/dev/ad0s1f</filename> is the data
+ provider, and <filename class="devicefile">/dev/ad0s1g</filename> is
the journal provider. This new device is then used for all
subsequent file operations.</para>
</listitem>
</itemizedlist>
<para>The amount of disk space you need to reserve for the journal
- provider depends on the usage load of the filesystem and not on the
+ provider depends on the usage load of the file system and not on the
size of the data provider. For example on a typical office desktop,
- a 1Gb journal provider for the <filename>/usr</filename> filesystem
+ a 1 GB journal provider for the <filename>/usr</filename> file system
will suffice, while a machine that deals with heavy disk I/O (i.e.
video editing) may need more. A kernel panic will occur if the
journal space is exhausted before it has a chance to be
@@ -191,10 +191,10 @@
</sect1>
<sect1 id="reserve-space">
- <title>Steps during the installation of &os;</title>
+ <title>Steps During the Installation of &os;</title>
<sect2>
- <title>Reserving space for journaling</title>
+ <title>Reserving Space for Journaling</title>
<para>A typical desktop machine usually has one hard disk that stores
both the OS and user data. Arguably, the default partitioning scheme
@@ -202,17 +202,17 @@
suitable: A desktop machine does not need a large
<filename>/var</filename> partition, while <filename>/usr</filename>
is allocated the bulk of the disk space, since user data and a lot of
- packages are installed into its sub-directories.</para>
+ packages are installed into its subdirectories.</para>
<para>The default partitioning (the one obtained by pressing
- <keycap>A</keycap> at the disklabel editor) does not leave any
+ <keycap>A</keycap> at the &os; partition editor, called <application>Disklabel</application>) does not leave any
unallocated space. Each partition that will be journaled, requires
another partition for the journal. Since the <filename>/usr</filename>
partition is the largest, it makes sense to shrink this partition
slightly, to obtain the space required for journaling.</para>
- <para>In our example, an 80Gb disk is used. The following screenshot
- shows the default partitions created by the disklabel editor during
+ <para>In our example, an 80 GB disk is used. The following screenshot
+ shows the default partitions created by <application>Disklabel</application> during
installation:</para>
<mediaobject>
@@ -222,25 +222,25 @@
</mediaobject>
<para>If this is more or less what you need, it is very easy to adjust
- for journaling. Simply use the <keycap>up</keycap> and
- <keycap>down</keycap> arrow keys to move the highlight to the
+ for journaling. Simply use the
+ arrow keys to move the highlight to the
<filename>/usr</filename> partition and press <keycap>D</keycap> to
delete it.</para>
<para>Now, move the highlight to the disk name at the top of the screen
and press <keycap>C</keycap> to create a new partition for
<filename>/usr</filename>. This new partition should be smaller by
- 1Gb (if you intend to journal <filename>/usr</filename> only), or
- 2Gb (if you intend to journal both <filename>/usr</filename> and
+ 1 GB (if you intend to journal <filename>/usr</filename> only), or
+ 2 GB (if you intend to journal both <filename>/usr</filename> and
<filename>/var</filename>). From the pop-up that appears, opt to
- create a filesystem, and type <filename>/usr</filename> as the mount
+ create a file system, and type <filename>/usr</filename> as the mount
point.</para>
<note>
<para>Should you journal the <filename>/var</filename> partition?
Normally, journaling makes sense on quite large partitions. You may
decide not to journal <filename>/var</filename>, although doing so
- on a typical desktop will cause no harm. If the filesystem is
+ on a typical desktop will cause no harm. If the file system is
lightly used (quite probable for a desktop) you may wish to
allocate less disk space for its journal.</para>
@@ -266,9 +266,9 @@
<filename>/etc/fstab</filename> will have to be edited, and the extra
swap space entries removed.</para>
- <para>To create the swap, again use the <keycap>up</keycap> and
- <keycap>down</keycap> arrow keys to move the highlight to the top of
- the disklabel editor screen, so that the disk name itself is
+ <para>To create the swap, again use the
+ arrow keys to move the highlight to the top of
+ <application>Disklabel</application> screen, so that the disk name itself is
highlighted. Then press <keycap>N</keycap>, enter the desired size
(<replaceable>1024M</replaceable>), and select
<quote>swap space</quote> from the pop-up menu that appears. Repeat
@@ -290,12 +290,12 @@
following table shows our notes for the sample configuration:</para>
<table pgwide="1">
- <title>Partitions and journals</title>
+ <title>Partitions and Journals</title>
<tgroup cols="3">
<thead>
<row>
<entry>Partition</entry>
- <entry>Mount point</entry>
+ <entry>Mount Point</entry>
<entry>Journal</entry>
</row>
</thead>
@@ -316,7 +316,7 @@
</table>
<para>Continue the installation as you would normally do. We would
- however suggest you postpone installation of add-on software
+ however suggest you postpone installation of third party software
(packages) until you have completely setup journaling.</para>
</sect2>
@@ -335,42 +335,42 @@
</sect2>
<sect1 id="configure-journal">
- <title>Setting up journaling</title>
+ <title>Setting Up Journaling</title>
<sect2 id="running-gjournal">
- <title>Executing gjournal</title>
+ <title>Executing <command>gjournal</command></title>
<para>Having prepared all the required partitions, it is quite easy
to configure journaling. We will need to switch to single user
- mode, so login as root and type:</para>
+ mode, so login as <username>root</username> and type:</para>
- <screen>&prompt.root; shutdown now</screen>
+ <screen>&prompt.root; <userinput>shutdown now</userinput></screen>
- <para>Press enter to get the default shell. We will need to unmount
+ <para>Press <keycap>Enter</keycap> to get the default shell. We will need to unmount
the partitions that will be journaled, in our example
- <filename>/usr </filename> and <filename>/var</filename>:</para>
+ <filename>/usr</filename> and <filename>/var</filename>:</para>
- <screen>&prompt.root; umount /usr /var</screen>
+ <screen>&prompt.root; <userinput>umount /usr /var</userinput></screen>
<para>Load the module required for journaling:</para>
- <screen>&prompt.root; gjournal load</screen>
+ <screen>&prompt.root; <userinput>gjournal load</userinput></screen>
<para>Now, use your notes to determine which partition will be used
for each journal. In our example, <filename>/usr</filename> is
- <filename role="device">ad0s1f</filename> and its journal will be
- <filename role="device">ad0s1g</filename>, while
More information about the Freebsd-doc-el
mailing list