[DRBD-cvs] r1939 - branches/drbd-0.7/documentation

drbd-cvs at lists.linbit.com drbd-cvs at lists.linbit.com
Thu Sep 1 09:20:30 CEST 2005


Author: phil
Date: 2005-09-01 09:20:28 +0200 (Thu, 01 Sep 2005)
New Revision: 1939

Modified:
   branches/drbd-0.7/documentation/Makefile
   branches/drbd-0.7/documentation/drbd.conf.sgml
   branches/drbd-0.7/documentation/drbd.sgml
   branches/drbd-0.7/documentation/drbdadm.sgml
   branches/drbd-0.7/documentation/drbdsetup.sgml
Log:
Doc updates by Helmut Wollmersdorfer


Modified: branches/drbd-0.7/documentation/Makefile
===================================================================
--- branches/drbd-0.7/documentation/Makefile	2005-08-31 18:07:05 UTC (rev 1938)
+++ branches/drbd-0.7/documentation/Makefile	2005-09-01 07:20:28 UTC (rev 1939)
@@ -28,7 +28,7 @@
 
 MAKEFILES_LANG := $(foreach dir,$(LANGS),$(dir)/Makefile)
 
-MANPAGES       := drbdsetup.8 drbd.conf.5 drbd.8 drbdadm.8
+MANPAGES       := drbdsetup.8 drbd.conf.5 drbd.8 drbdadm.8 drbddisk.8
 
 #
 # Docbook Magic for SuSE, Worksforme...

Modified: branches/drbd-0.7/documentation/drbd.conf.sgml
===================================================================
--- branches/drbd-0.7/documentation/drbd.conf.sgml	2005-08-31 18:07:05 UTC (rev 1938)
+++ branches/drbd-0.7/documentation/drbd.conf.sgml	2005-09-01 07:20:28 UTC (rev 1939)
@@ -79,7 +79,7 @@
   is considered
   as part of the parameters value. A special case are Boolean
   parameters which only consist of the identifier.
-  Parameters are terminated by a semikolon (<quote>;</quote>).
+  Parameters are terminated by a semicolon (<quote>;</quote>).
   </para>
   <para>Some parameter values have default units which might be overruled
   by K, M or G. These units are defined in the usual way (K = 2^10 = 1024,
@@ -219,7 +219,7 @@
   <para>Use <replaceable>minor-count</replaceable>
    if you want to define more resources later without reloading the DRBD kernel
    module. Per default the module loads with exactly as many devices as
-   configured in this file. Builtin default for module is 2, and 8 for
+   configured in this file. Built-in default for module is 2, and 8 for
    monolithic kernel. For monolithic kernel
    <replaceable>minor-count</replaceable> is ignored, and you have to pass a
    kernel boot parameter <replaceable>drbd.minor_count=count</replaceable> to
@@ -243,7 +243,7 @@
   <listitem>
   <para>Use <replaceable>disable-ip-verification</replaceable>
    if, for some obscure reasons, drbdadm can/might not use ip or ifconfig
-   to do a santiy check for the IP address, you can disable it with this
+   to do a sanity check for the IP address, you can disable it with this
    this option.
    </para>
    </listitem>
@@ -255,7 +255,7 @@
   <para>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>
+  reached 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
@@ -266,7 +266,7 @@
 <varlistentry>
   <term><option>incon-degr-cmd <replaceable>command</replaceable></option></term>
   <listitem><para>
-    In case a node starts up in degraded mode (inittimeout is set) and
+    In case a node starts up in degraded mode (degr-wfc-timeout is set) and
     its local replica of the data is inconsistent it executes the
     <replaceable>command</replaceable>. If the command exits without
     error, drbddisk expects the DRBD device to be in primary state.
@@ -409,7 +409,7 @@
   Maximal number of requests to be allocated by DRBD. Unit is PAGE_SIZE,
   which is 4 KB on most systems.
   The minimum is hardcoded to 32 (=128 KB).
-  For hight performance installations it might help, if you
+  For high performance installations it might help, if you
   increase that number. These buffers are used to hold
   datablocks while they are written to disk.
   </para></listitem>
@@ -527,7 +527,7 @@
 </refsect1>
 <refsect1>
 <title>Version</title>
-<simpara>This document is correct for version 0.7.5 of the DRBD distribution.
+<simpara>This document is correct for version 0.7.13 of the DRBD distribution.
 </simpara>
 </refsect1>
 <refsect1>
@@ -544,7 +544,7 @@
 <refsect1>
 <title>Copyright</title>
 <simpara>
-Copyright (c) 2001 Philipp Reisner. This  is  free software; 
+Copyright (c) 2001-2005 Philipp Reisner. This  is  free software; 
 see the source for copying conditions.  There is NO warranty; 
 not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 </simpara>

Modified: branches/drbd-0.7/documentation/drbd.sgml
===================================================================
--- branches/drbd-0.7/documentation/drbd.sgml	2005-08-31 18:07:05 UTC (rev 1938)
+++ branches/drbd-0.7/documentation/drbd.sgml	2005-09-01 07:20:28 UTC (rev 1939)
@@ -20,6 +20,9 @@
       <arg choice=req>start</arg>
       <arg choice=req>stop</arg>
       <arg choice=req>status</arg>
+      <arg choice=req>reload</arg>
+      <arg choice=req>restart</arg>
+      <arg choice=req>force-reload</arg>
     </group>
     </arg>
  </cmdsynopsis>
@@ -49,6 +52,12 @@
 </refsect1>
 
 <refsect1>
+  <title>Version</title>
+  <simpara>This document is correct for version 0.7.13 of the DRBD distribution.
+  </simpara>
+</refsect1>
+
+<refsect1>
   <title>Author</title>
   <simpara>
     Written by Philipp Reisner <email>philipp.reisner at linbit.com</email>.
@@ -65,9 +74,9 @@
 <refsect1>
   <title>Copyright</title>
   <simpara>
-    Copyright (c) 2001 Philipp Reisner. This  is  free software; 
+    Copyright (c) 2001-2005 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>
 
@@ -76,10 +85,12 @@
   <para>
     <citerefentry><refentrytitle>drbd.conf</refentrytitle>
     <manvolnum>5</manvolnum></citerefentry>,
-    <citerefentry><refentrytitle>datadisk</refentrytitle>
+    <citerefentry><refentrytitle>drbddisk</refentrytitle>
     <manvolnum>8</manvolnum></citerefentry>,
     <citerefentry><refentrytitle>drbdsetup</refentrytitle>
     <manvolnum>8</manvolnum></citerefentry>
+    <citerefentry><refentrytitle>drbdadm</refentrytitle>
+    <manvolnum>8</manvolnum></citerefentry>
   </para>
 </refsect1>
 

Modified: branches/drbd-0.7/documentation/drbdadm.sgml
===================================================================
--- branches/drbd-0.7/documentation/drbdadm.sgml	2005-08-31 18:07:05 UTC (rev 1938)
+++ branches/drbd-0.7/documentation/drbdadm.sgml	2005-09-01 07:20:28 UTC (rev 1939)
@@ -49,8 +49,8 @@
           <replaceable>file</replaceable></term>
         <listitem><para>
           Specifies the configuration file drbdadm will use. If this parameter
-	  is not specified, drbdadm will look for /etc/drbd-07.conf and
-          /etc/drbd.conf.
+	  is not specified, drbdadm will look for <option>/etc/drbd-07.conf</option> and
+          <option>/etc/drbd.conf</option>.
 	</para></listitem>
       </varlistentry>
       <varlistentry>
@@ -58,7 +58,7 @@
           <replaceable>file</replaceable></term>
         <listitem><para>
           Specifies the full path to the drbdsetup program. If this option is
-	  omitted, drbdadm will look for /sbin/drbdsetup and ./drbdsetup.
+	  omitted, drbdadm will look for <option>/sbin/drbdsetup</option> and <option>./drbdsetup</option>.
 	</para></listitem>
       </varlistentry>
     </variablelist>
@@ -96,7 +96,7 @@
       <varlistentry>
         <term>syncer</term>
         <listitem><para>
-          Loads the resynchronisation parameters into the device.
+          Loads the resynchronization parameters into the device.
         </para></listitem>
       </varlistentry>
       <varlistentry>
@@ -138,7 +138,7 @@
       <varlistentry>
         <term>invalidate_remote</term>
         <listitem><para>
-          This command is simmilar to the invalidate command, but the
+          This command is similar to the invalidate command, but the
 	  backing storage of the peer is invalidated and hence rewritten
 	  with the data of the local node.
         </para></listitem>
@@ -146,7 +146,7 @@
       <varlistentry>
         <term>resize</term>
         <listitem><para>
-          DRBD will reexamine all sizing constraints, and resize the
+          DRBD will reexamine all sizing constraints, and re-size the
 	  resource's device accordingly. E.g. in case you increased the
 	  size of your backing storage devices (on both nodes of course),
 	  then DRBD will adopt to the new size after you called 
@@ -192,7 +192,7 @@
   <refsect1>
     <title>Version</title>
     <simpara>
-      This document is correct for version 0.7 of the DRBD distribution.
+      This document is correct for version 0.7.13 of the DRBD distribution.
     </simpara>
   </refsect1>
 
@@ -209,7 +209,7 @@
   <refsect1>
     <title>Copyright</title>
     <simpara>
-      Copyright (c) 2004 Philipp Reisner. This  is  free software; 
+      Copyright (c) 2004-2005 Philipp Reisner. This  is  free software; 
       see the source for copying conditions.  There is NO warranty; 
       not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
     </simpara>
@@ -223,6 +223,8 @@
       <manvolnum>8</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>drbddisk</refentrytitle>
       <manvolnum>8</manvolnum></citerefentry>
+      <citerefentry><refentrytitle>drbdsetup</refentrytitle>
+      <manvolnum>8</manvolnum></citerefentry>
     </para>
   </refsect1>
 </refentry>

Modified: branches/drbd-0.7/documentation/drbdsetup.sgml
===================================================================
--- branches/drbd-0.7/documentation/drbdsetup.sgml	2005-08-31 18:07:05 UTC (rev 1938)
+++ branches/drbd-0.7/documentation/drbdsetup.sgml	2005-09-01 07:20:28 UTC (rev 1939)
@@ -659,7 +659,7 @@
 
   <refsect1>
     <title>Version</title>
-    <simpara>This document is intended to be correct for version 0.7.x of the DRBD distribution.
+    <simpara>This document is correct for version 0.7.13 of the DRBD distribution.
     </simpara>
   </refsect1>
 
@@ -676,7 +676,7 @@
   <refsect1>
     <title>Copyright</title>
     <simpara>
-      Copyright (c) 2001 Philipp Reisner. This  is  free software; 
+      Copyright (c) 2001-2005 Philipp Reisner. This  is  free software; 
       see the source for copying conditions.  There is NO warranty; 
       not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
     </simpara>
@@ -688,8 +688,10 @@
       <manvolnum>5</manvolnum></citerefentry>,
       <citerefentry><refentrytitle>drbd</refentrytitle>
       <manvolnum>8</manvolnum></citerefentry>,
-      <citerefentry><refentrytitle>datadisk</refentrytitle>
+      <citerefentry><refentrytitle>drbddisk</refentrytitle>
       <manvolnum>8</manvolnum></citerefentry>
+      <citerefentry><refentrytitle>drbdadm</refentrytitle>
+      <manvolnum>8</manvolnum></citerefentry>
     </para>
   </refsect1>
 </refentry>



More information about the drbd-cvs mailing list