Browse Source

[3513] Update the doc for -W and fix some typos

Shawn Routhier 10 years ago
parent
commit
17d00a3257
3 changed files with 18 additions and 16 deletions
  1. 14 12
      doc/guide/ddns.xml
  2. 2 2
      src/bin/cfgrpt/cfgrpt.cc
  3. 2 2
      src/bin/cfgrpt/config_report.h

+ 14 - 12
doc/guide/ddns.xml

@@ -100,21 +100,23 @@
       </itemizedlist>
 
       <para>
-            The <command>-V</command> returns the versions of the
-            external libraries dynamically linked, at the opposite
-            the <command>-W</command> describes the environment used
-            to build Kea.
+            The <command>-V</command> command returns the versions of the
+            external libraries dynamically linked.
       </para>
 
       <para>
-            All of the executable binaries in Kea contain an embedded
-            copy of the <filename>config.report</filename>
-            file produced by <userinput>./configure</userinput>
-            and displayed by the <command>-W</command> command,
-            but is accessible in some other ways when needed.
-            The following command may be used to extract this information.
-            The binary <userinput>path</userinput> may be found in the
-            install directory or in the <filename>.libs</filename>
+            The <command>-W</command> command describes the environment used
+            to build Kea.  This command displays a copy of the
+            <filename>config.report</filename> file produced by
+            <userinput>./configure</userinput> that is embedded in the
+            executable binary.
+      </para>
+
+      <para>
+            The <filename>config.report</filename> may also be accessed more
+            directly.  The following command may be used to extract this
+            information.  The binary <userinput>path</userinput> may be found
+            in the install directory or in the <filename>.libs</filename>
             subdirectory in the source treee. For example
             <filename>kea/src/bin/d2/.libs/kea-dhcp-ddns</filename>.
 <screen>

+ 2 - 2
src/bin/cfgrpt/cfgrpt.cc

@@ -19,8 +19,8 @@
 namespace isc {
 namespace detail {
 
-// The config_report array finished by an empty line ("")
-// Each line before this final one begins by four semicolons (;;;;)
+// The config_report array ends with an empty line ("")
+// Each line before this final one starts with four semicolons (;;;;)
 // in order to be easy to extract from binaries.
 std::string
 getConfigReport() {

+ 2 - 2
src/bin/cfgrpt/config_report.h

@@ -20,8 +20,8 @@ namespace detail {
 
 extern const char* const config_report[];
 
-// The config_report array finished by an empty line ("")
-// Each line before this final one begins by four semicolons (;;;;)
+// The config_report array ends with an empty line ("")
+// Each line before this final one starts with four semicolons (;;;;)
 // in order to be easy to extract from binaries.
 std::string getConfigReport();