[DRBD-cvs] documentation by phil; [patches by Helmut Wollmersdorfer] Fixes...

drbd-user@lists.linbit.com drbd-user@lists.linbit.com
Mon, 14 Jun 2004 20:01:04 +0200 (CEST)


DRBD CVS committal

Author  : phil
Project : drbd
Module  : documentation

Dir     : drbd/documentation


Modified Files:
      Tag: rel-0_7-branch
	drbdsetup.sgml 


Log Message:
[patches by Helmut Wollmersdorfer] 
 Fixes to drbdsetup's manpages and to the sample configuration file.

===================================================================
RCS file: /var/lib/cvs/drbd/drbd/documentation/drbdsetup.sgml,v
retrieving revision 1.9.2.5
retrieving revision 1.9.2.6
diff -u -3 -r1.9.2.5 -r1.9.2.6
--- drbdsetup.sgml	9 Jun 2004 20:06:36 -0000	1.9.2.5
+++ drbdsetup.sgml	14 Jun 2004 18:00:59 -0000	1.9.2.6
@@ -159,7 +159,7 @@
 	  <listitem>
 	    <para>
 	      You can override DRBD's size determination method with this
-	      option.  If you need to use the device before it was ever
+	      option. If you need to use the device before it was ever
 	      connected to its peer, use this option to pass the
 	      <replaceable>size</replaceable> of the DRBD device to the
 	      driver. Default unit is KB (1 KB = 1024 bytes).
@@ -172,8 +172,8 @@
 	  <listitem>
 	    <para>
 	      If the driver of the <replaceable>lower_device</replaceable>
-	      reports an error to DRBD, DRBD will either pass the error on
-	      the the upper layers of the operating system, panic the
+	      reports an error to DRBD, DRBD will either pass the error 
+	      to the upper layers of the operating system, panic the
 	      machine, or detaches the device from its backing storage and
 	      perform all futher IO by requesting it from the peer. The
 	      valid <replaceable>err_handler</replaceable> are:
@@ -196,7 +196,7 @@
 	On the TCP/IP link the specified <replaceable>protocol</replaceable>
 	is used. Valid protocol specifiers are A, B, and C.</para>
 	<para>Protocol A: write IO is reported as completed, if it has reached
-	local disk and local tcp send buffer.</para>
+	local disk and local TCP send buffer.</para>
 	<para>Protocol B: write IO is reported as completed, if it has reached
 	local disk and remote buffer cache.</para>
 	<para>Protocol C: write IO is reported as completed, if it has
@@ -235,7 +235,7 @@
 	      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.  The default value is 60 = 6 seconds.
+	      abandoned. The default value is 60 = 6 seconds.
 	    </para>
 	  </listitem>
 	</varlistentry>
@@ -251,7 +251,7 @@
 	      structure in order to increase asynchronism between primary
 	      and secondary nodes. But keep in mind that more asynchronism
 	      is synonymous with more data loss in the case of a primary
-	      node failure.  The default <replaceable>size</replaceable> is
+	      node failure. The default <replaceable>size</replaceable> is
 	      128 KB. Default unit is KB.  
 	    </para>
 	  </listitem>
@@ -264,7 +264,7 @@
 	      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.)
+	      cluster. (I.e. the primary node goes into StandAlone mode.)
 	      The default is 0, which disables this feature.
 	      </para>
 	  </listitem>
@@ -276,8 +276,8 @@
 	    <para>
 	      With this option the maximal number of write requests between
 	      two barriers is limited. Should be set to the same as
-	      <option>--max-buffers </option>.  Values smaller then 100 can
-	      lead to degraded performace.  The default is 2048.
+	      <option>--max-buffers </option>. Values smaller then 100 can
+	      lead to degraded performace. The default is 2048.
 	      </para>
 	  </listitem>
 	</varlistentry>
@@ -288,7 +288,7 @@
 	    <para>
 	      With this option the maximal number of buffer pages allocated
 	      by DRBD's receiver thread is limited. Should be set to the
-	      same as <option>--max-epoch-size </option>.  Small values
+	      same as <option>--max-epoch-size </option>. Small values
 	      could lead to degraded performace. (Minimum 32) The default is
 	      2048.  
 	    </para>
@@ -302,9 +302,9 @@
 	      When the connection to the peer is lost, DRBD can either
 	      go into stand alone mode, try to reconnect to the peer or
 	      freeze all further IO requests (think of an NFS hard mount).
-	      The keywords are: <option>stand_allone</option>, 
+	      The keywords are: <option>stand_alone</option>, 
 	      <option>reconnect</option> and <option>freeze_io</option>.
-	      The default hander is <option>reconnect</option>.
+	      The default handler is <option>reconnect</option>.
 	    </para>
 	  </listitem>
 	</varlistentry>
@@ -364,7 +364,7 @@
 	      by the active set must be resynced upon rejoin of the failed
 	      node. The data structure is stored in the meta-data area,
 	      therefore each change of the active set is a write operation
-	      to the meta-data device.  A highter number extents gives
+	      to the meta-data device. A higher number of extents gives
 	      longer resync times but less updates to the meta-data. The
 	      default number of <replaceable>extents</replaceable> is
 	      127. (Minimum: 7, Maximum: 3843) 
@@ -417,7 +417,7 @@
 	    <para>
 	      Becoming primary fails if the local replica is
 	      inconsistent. By using this option you can force it into
-	      primary state anyway.  USE THIS OPTION ONLY IF YOU KNOW WHAT
+	      primary state anyway. USE THIS OPTION ONLY IF YOU KNOW WHAT
 	      YOU ARE DOING.
 	    </para>
 	  </listitem>
@@ -427,8 +427,8 @@
     <refsect2>
       <title>secondary</title>
       <para>
-	Sets the <replaceable>device</replaceable> into secondary state,
-	this operation fails as long as at least one application (or file
+	Sets the <replaceable>device</replaceable> into secondary state.
+	This operation fails as long as at least one application (or file
 	system) has the device open for write access.
       </para>
       <para>
@@ -440,7 +440,7 @@
       <title>invalidate</title>
       <para>
 	This forces the local device of a pair of connected DRBD devices
-	into SyncTarget state , which means that all data blocks of the
+	into SyncTarget state, which means that all data blocks of the
 	device are copied over from the peer.
       </para>
       <para>
@@ -493,7 +493,7 @@
 	      This command will fail if the
 	      <replaceable>device</replaceable> stays for
 	      <replaceable>connect_timeout</replaceable> seconds in
-	      unconnected state. The default value is 8 seconds.  If it is
+	      unconnected state. The default value is 8 seconds. If it is
 	      set to 0, the command will forever wait for a connection.
 	    </para>
 	  </listitem>
@@ -536,7 +536,7 @@
     <refsect2>
       <title>resize</title>
       <para>
-	The causes DRBD to reexamine the size of the
+	This causes DRBD to reexamine the size of the
 	<replaceable>device</replaceable>'s backing storage device.  To
 	actually do online growing you need to extend the backing storages
 	on both devices and call the <option>resize</option> command on both
@@ -572,7 +572,7 @@
 	$ drbdsetup /dev/nb0 net 192.168.37.3 192.168.37.2 B
 	$ drbdsetup /dev/nb0 primary
 	$ cat /proc/drbd
-	<computeroutput>version       : 58
+	<computeroutput>version: 0.7.0 (api:xx/proto:yy)
 
 	0: cs:Connected st:Primary/Secondary ns:0 nr:0 dw:0 dr:0 of:0
 	1: cs:WFConnection st:Secondary/Unknown ns:0 nr:0 dw:0 dr:0 of:0