[DRBD-cvs] documentation by phil; Improvements to the documentation by Hel...
drbd-user@lists.linbit.com
drbd-user@lists.linbit.com
Sun, 18 Jan 2004 21:24:05 +0100 (CET)
DRBD CVS committal
Author : phil
Project : drbd
Module : documentation
Dir : drbd/documentation
Modified Files:
datadisk.sgml drbd.conf.sgml drbd.sgml drbdsetup.sgml
Log Message:
Improvements to the documentation by Helmut Wollmersdorfer.
(changes were reviewed by LGE)
===================================================================
RCS file: /var/lib/cvs/drbd/drbd/documentation/datadisk.sgml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -3 -r1.3 -r1.4
--- datadisk.sgml 29 Nov 2002 11:15:22 -0000 1.3
+++ datadisk.sgml 18 Jan 2004 20:24:05 -0000 1.4
@@ -28,7 +28,7 @@
<refsect1>
<title>Introduction</title>
<para>
- The <option>/etc/ha.d/resource.d/datadisk</option> script is used
+ The <option>/etc/ha.d/resource.d/datadisk</option> script
brings the local device of <replaceable>resource</replaceable> into
primary state and mounts the filesystem on it. It is designed to be
used by heartbeat.
@@ -67,7 +67,7 @@
<simpara>
Copyright (c) 2001 Philipp Reisner. This is free software;
see the source for copying conditions. There is NO warranty;
- not even for MERCHANTABILIT or FITNESS FOR A PARTICULAR PURPOSE.
+ not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
</simpara>
</refsect1>
===================================================================
RCS file: /var/lib/cvs/drbd/drbd/documentation/drbd.conf.sgml,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -3 -r1.11 -r1.12
--- drbd.conf.sgml 22 May 2003 11:38:00 -0000 1.11
+++ drbd.conf.sgml 18 Jan 2004 20:24:05 -0000 1.12
@@ -15,7 +15,7 @@
<refsect1>
<title>Introduction</title>
<para>
-The file <option>/etc/drbd.conf</option>, is read by
+The file <option>/etc/drbd.conf</option> is read by
<option>/etc/init.d/drbd</option> and
<option>/etc/ha.d/resrouce.d/datadisk</option>
which are included in the drbd distribution.
@@ -48,7 +48,7 @@
}
</programlisting>
</example>
-In this example there is a singe DRBD resource (called drbd0) which uses
+In this example there is a single DRBD resource (called drbd0) which uses
protocol C for the connection between its devices. The application
of this resource is an ext2 file system, since the command to restart
it is <replaceable>fsck.ext2 -p -y</replaceable>.
@@ -59,7 +59,7 @@
The IP addresses are used to specify the networking interfaces to use.
</para>
<para>
-There may be multiple resource sections in a singe drbd.conf file.
+There may be multiple resource sections in a single drbd.conf file.
</para>
</refsect1>
<refsect1>
@@ -74,9 +74,9 @@
A parameter line starts with the identifier of the parameter followed
by an equal sign (<quote>=</quote>). Every subsequent character on
that line is considered
-as part of the parameters value. There must not be a single white space
-between the identifier and the equal sing. A special case are Boolean
-parameters which only consists of the identifier.
+as part of the parameters value. White space surrounding the equal
+sign is ignored. A special case are Boolean
+parameters which only consist of the identifier.
</para>
<para>
Comment lines may be placed into the configuration file and must
@@ -102,8 +102,8 @@
Each resource section needs to have two host sections
(keyword <option>on</option>) and may have
a <option>net</option> and a <option>disk</option> section.
- Required parameter in this section: <option>protocol</option>,
- <option>fsckcmd</option>. Optinal parameters are <option>inittimeout
+ Required parameters in this section: <option>protocol</option>,
+ <option>fsckcmd</option>. Optional parameters are <option>inittimeout
</option>, <option>skip-wait</option> and
<option>incon-degr-cmd</option>.
</para>
@@ -178,8 +178,8 @@
If <replaceable>value</replaceable> is positive, and the other node does
not show up within the specified time (seconds), this node will start the
resource in degraded mode, read: forces primary status on this node.</para>
- <para>Only use this option if availabiliy is more important to you then
- the consitency of your data.</para>
+ <para>Only use this option if availability is more important to you than
+ the consistency of your data.</para>
<para>If <replaceable>value</replaceable> is negative, and the other node
does not show up within the specified time (seconds), this node stays in
WFConnection:Secondary/Unknown state, and just lets the boot process
@@ -283,7 +283,7 @@
<simpara>
Copyright (c) 2001 Philipp Reisner. This is free software;
see the source for copying conditions. There is NO warranty;
-not even for MERCHANTABILIT or FITNESS FOR A PARTICULAR PURPOSE.
+not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
</simpara>
</refsect1>
<refsect1>
===================================================================
RCS file: /var/lib/cvs/drbd/drbd/documentation/drbd.sgml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -3 -r1.2 -r1.3
--- drbd.sgml 29 Nov 2002 11:15:22 -0000 1.2
+++ drbd.sgml 18 Jan 2004 20:24:05 -0000 1.3
@@ -36,7 +36,7 @@
In order to use <option>/etc/init.d/drbd</option> you must define
a resource, a host, and any other configuration options in the drbd
configuration file. See <option>/etc/drbd.conf</option> for details.
- If <replaceable>resource</replaceable> is omited, then all of the
+ If <replaceable>resource</replaceable> is omitted, then all of the
resouces listed in the config file are configured.
</para>
<para>
@@ -82,7 +82,7 @@
<simpara>
Copyright (c) 2001 Philipp Reisner. This is free software;
see the source for copying conditions. There is NO warranty;
- not even for MERCHANTABILIT or FITNESS FOR A PARTICULAR PURPOSE.
+ not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
</simpara>
</refsect1>
===================================================================
RCS file: /var/lib/cvs/drbd/drbd/documentation/drbdsetup.sgml,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -3 -r1.14 -r1.15
--- drbdsetup.sgml 6 Jan 2004 10:06:25 -0000 1.14
+++ drbdsetup.sgml 18 Jan 2004 20:24:05 -0000 1.15
@@ -123,7 +123,7 @@
<para>
Each drbd sub-command might require arguments and bring its own
set of options. All values have default units which might be overruled
-by K, M or G. These units are defined in the usual way (eg. K = 2^10).
+by K, M or G. These units are defined in the usual way (e.g. K = 2^10).
</para>
<refsect2>
@@ -171,8 +171,8 @@
<replaceable>local_addr:port</replaceable> for incoming connections
and to try to connect to <replaceable>remote_addr:port</replaceable>.
If <replaceable>port</replaceable> is omitted, 7788 is used as default.
-On the tcp/ip link the specified <replaceable>protocol</replaceable>
-is used. Valid protocol spezifiers are A, B and C.
+On the TCP/IP link the specified <replaceable>protocol</replaceable>
+is used. Valid protocol specifiers are A, B and C.
</para>
<variablelist>
<varlistentry>
@@ -206,16 +206,16 @@
<listitem><para>
This sets the normal nice-level for background synchronization.
Valid values are [-20 to 19], inclusive. Higher number means lower
-priority. This is used for the sync-deamon if the current
+priority. This is used for the sync-daemon if the current
synchronization throughput is between the sync-min and sync-max values,
-see above. The default is 19, i.e. lowest priority.
+see above. The default is 19, i.e. lowest priority.
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-k</option>,
<option>--skip-sync </option></term>
<listitem><para>
-This option supresses the automatic start of the resynchronisation
+This option suppresses the automatic start of the resynchronisation
process, which
is triggered as soon as two drbd devices are connected.
</para></listitem>
@@ -225,8 +225,8 @@
<option>--sync-group <replaceable>group</replaceable></option></term>
<listitem><para>
Resynchronisation of all devices in one group runs parallel. Groups are
-serialized in ascending order. You should avoid that devices whichs
-lower devices are on the one physical disk sync in parallel. The default
+serialized in ascending order. You should avoid that drbd devices which
+lower devices share one and the same physical disk sync in parallel. The default
group is 0. I.e. per default all devices sync parallel.
</para></listitem>
</varlistentry>
@@ -244,7 +244,7 @@
<term><option>-i</option>,
<option>--ping-int <replaceable>time</replaceable></option></term>
<listitem><para>
-If the tcp/ip connection linking a drbd device pair is idle for more than
+If the TCP/IP connection linking a drbd device pair is idle for more than
<replaceable>time</replaceable> seconds, drbd will generate a keep-alive
packet to check if its partner is still alive. The default is 10 seconds.
</para></listitem>
@@ -253,10 +253,10 @@
<term><option>-t</option>,
<option>--timeout <replaceable>val</replaceable></option></term>
<listitem><para>
-If the partner node failes to send an expected response packet within
+If the partner node fails to send an expected response packet within
<replaceable>val</replaceable> 10<superscript>ths</superscript>
of a second, the partner node
-is considered dead and therefore the tcp/ip connection is abandoned.
+is considered dead and therefore the TCP/IP connection is abandoned.
The default value is 60 = 6 seconds.
</para></listitem>
</varlistentry>
@@ -291,7 +291,7 @@
<option>--ko-count <replaceable>count</replaceable></option></term>
<listitem>
<para>
-In case the secondary node failes to complete a single write requests
+In case the secondary node fails to complete a single write request
for <replaceable>count</replaceable> times the
<replaceable>timeout</replaceable>, it is expelled from the cluster.
(I.e. the primary node goes into StandAlone mode.)
@@ -303,7 +303,7 @@
<refsect2>
<title>syncer</title>
<para>
-Changes the synchronization deamon parameters of
+Changes the synchronization daemon parameters of
<replaceable>device</replaceable> at runtime.
Not mentioned parameters will not be changed.
</para>
@@ -353,7 +353,7 @@
<option>--human</option></term>
<listitem><para>
Indicates that this state change was issued by an administrator and has
-at cluster restart time precedence over decissions made by other parties.
+at cluster restart time precedence over decisions made by other parties.
</para></listitem>
</varlistentry>
<varlistentry>
@@ -362,7 +362,7 @@
<listitem><para>
Indicates that this state change was caused because a node did not showed
up on cluster startup (The cluster started in degraded mode). At cluster
-restart this this has precedence over decissions made by the cluster manager.
+restart this has precedence over decisions made by the cluster manager.
</para></listitem>
</varlistentry>
<varlistentry>
@@ -425,7 +425,7 @@
<listitem><para>
This command will fail if the <replaceable>device</replaceable> can not
communicate with its partner for <replaceable>connect_timeout</replaceable>
-seconds. The default value is 0 which disables the timeout machanism.
+seconds. The default value is 0 which disables the timeout mechanism.
</para></listitem>
</varlistentry>
</variablelist>
@@ -455,7 +455,7 @@
Removes the information set by the <option>net</option> command
from the <replaceable>device</replaceable>. This means
that the <replaceable>device</replaceable> goes into unconnected
-states and that it will no longer listen for incomming connections.
+state and that it will no longer listen for incomming connections.
</para>
</refsect2>
<refsect2>
@@ -501,7 +501,7 @@
1: cs:WFConnection st:Secondary/Unknown ns:0 nr:0 dw:0 dr:0 of:0
</computeroutput>
</screen>
-<para>From /prod/drbd we can see, that our device pair is connected, and
+<para>From /proc/drbd we can see, that our device pair is connected, and
that the device is ready for use on tc2.</para>
<para>We can now run our application on top of it:</para>
<screen>
@@ -531,15 +531,15 @@
$ drbdsetup /dev/nb0 net tc2 tc1 B
$ #drbdsetup /dev/nb0 replicate
</screen>
-<para>With release 0.5.8 drbd's meta-data management can not detect changing
+<para>With release 0.6.x drbd's meta-data management still can not detect changing
mirroring partners. Therefore you might have to issue
the replicate commands as outlined in the example.</para>
<para>Since the snapshot was taken without bringing the on disk file
-system into a consisten state we need theese commands on tc3:</para>
+system into a consistent state we need these commands on tc3:</para>
<screen>
$ drbdsetup /dev/nb0 down
$ fsck /dev/hda6
-$ mount /dev/hda6 /some/mountpint
+$ mount /dev/hda6 /some/mountpoint
</screen>
</example>
</refsect1>
@@ -558,7 +558,7 @@
<simpara>
Copyright (c) 2001 Philipp Reisner. This is free software;
see the source for copying conditions. There is NO warranty;
-not even for MERCHANTABILIT or FITNESS FOR A PARTICULAR PURPOSE.
+not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
</simpara>
</refsect1>
<refsect1>