Parcourir la source

just keep sentence together

versus splitting sentence with example in  middle.
This is just my style preference.

While doing this fix the explanation for enabling mysql and postgres
as previously it appeared to imply that you had to specify
the path to the config script (but first example didn't follow what
was stated).
Jeremy C. Reed il y a 10 ans
Parent
commit
0e421bf275
4 fichiers modifiés avec 27 ajouts et 26 suppressions
  1. 3 2
      doc/guide/dhcp4-srv.xml
  2. 3 2
      doc/guide/dhcp6-srv.xml
  3. 13 14
      doc/guide/install.xml
  4. 8 8
      doc/guide/keactrl.xml

+ 3 - 2
doc/guide/dhcp4-srv.xml

@@ -247,7 +247,9 @@ url="http://jsonviewer.stack.hu/"/>.
   parameters. Let's comment this out When default parameters are used, the
   Memfile backend will write leases to a disk in the
   [kea-install-dir]/var/kea/kea-leases4.csv. -->
-  The following configuration:
+  The following configuration sets the name of the lease file to
+  /tmp/kea-leases4.csv:
+
 <screen>
 "Dhcp4": {
     "lease-database": {
@@ -258,7 +260,6 @@ url="http://jsonviewer.stack.hu/"/>.
     ...
 }
 </screen>
-  ...sets the name of the lease file to /tmp/kea-leases4.csv.
   </para>
 
   <para>The "persist" parameter controls whether the leases are written to disk.

+ 3 - 2
doc/guide/dhcp6-srv.xml

@@ -254,7 +254,9 @@ JSON validator is available at <ulink url="http://jsonviewer.stack.hu/"/>.
   parameters. Let's comment this out When default parameters are used, the
   Memfile backend will write leases to a disk in the
   [kea-install-dir]/var/kea/kea-leases4.csv. -->
-  The following configuration:
+  The following configuration sets the name of the lease file to
+  /tmp/kea-leases6.csv:
+
 <screen>
 "Dhcp6": {
     "lease-database": {
@@ -265,7 +267,6 @@ JSON validator is available at <ulink url="http://jsonviewer.stack.hu/"/>.
     ...
 }
 </screen>
-  ...sets the name of the lease file to /tmp/kea-leases6.csv.
   </para>
 
   <para>The "persist" parameter controls whether the leases are written to disk.

+ 13 - 14
doc/guide/install.xml

@@ -448,14 +448,12 @@ Debian and Ubuntu:
         </para>
         <para>
           Build and install Kea as described in <xref linkend="installation"/>, with
-          the following modification: to enable the MySQL database code, at the
-          "configure" step (see <xref linkend="configure"/>), specify the location of the
-          MySQL configuration program "mysql_config" with the "--with-dhcp-mysql" switch,
-          i.e.
+          the following modification. To enable the MySQL database code, at the
+          "configure" step (see <xref linkend="configure"/>), do:
           <screen><userinput>./configure [other-options] --with-dhcp-mysql</userinput></screen>
-          ...if MySQL was installed in the default location, or:
+	  Or specify the location of the MySQL configuration program
+	  "mysql_config" if MySQL was not installed in the default location:
           <screen><userinput>./configure [other-options] --with-dhcp-mysql=<replaceable>path-to-mysql_config</replaceable></userinput></screen>
-          ...if not.
         </para>
       </section>
       <section id="dhcp-mysql-database-create">
@@ -474,7 +472,8 @@ mysql></screen>
         <para>
           2. Create the database:
           <screen>mysql> <userinput>CREATE DATABASE <replaceable>database-name</replaceable>;</userinput></screen>
-          ... <replaceable>database-name</replaceable> is the name you have chosen for the database.
+	  (<replaceable>database-name</replaceable> is the name you
+	  have chosen for the database.)
         </para>
          <para>
           3. Create the database tables by running the dhcpdb_create.mysql script supplied as part of Kea:
@@ -503,14 +502,13 @@ $</screen>
         </para>
         <para>
           Build and install Kea as described in <xref linkend="installation"/>, with
-          the following modification: to enable the PostgreSQL database code, at the
-          "configure" step (see <xref linkend="configure"/>), specify the location of the
-          PostgreSQL configuration program "pg_config" with the "--with-dhcp-pgsql" switch,
-          i.e.
+          the following modification. To enable the PostgreSQL database code, at the
+          "configure" step (see <xref linkend="configure"/>), do:
           <screen><userinput>./configure [other-options] --with-dhcp-pgsql</userinput></screen>
-          ...if PostgreSQL was installed in the default location, or:
+	  Or specify the location of the PostgreSQL configuration
+	  program "pg_config" if PostgreSQL was not installed in
+	  the default location:
           <screen><userinput>./configure [other-options] --with-dhcp-pgsql=<replaceable>path-to-pg_config</replaceable></userinput></screen>
-          ...if not.
         </para>
       </section>
       <section id="dhcp-pgsql-database-create">
@@ -533,7 +531,8 @@ postgres=#<userinput> CREATE DATABASE <replaceable>database-name</replaceable>;<
 CREATE DATABASE
 postgres=#
 </screen>
-          ... <replaceable>database-name</replaceable> is the name you have chosen for the database.
+	  (<replaceable>database-name</replaceable> is the name you
+	  have chosen for the database.)
         </para>
          <para>
           3. Create the user under which Kea will access the database (and give it a password), then grant it access to the database:

+ 8 - 8
doc/guide/keactrl.xml

@@ -214,23 +214,23 @@ keactrl configuration file: /usr/local/etc/kea/keactrl.conf
       <para>
         The optional <command>-s</command> switch allows
         the selection of the servers to which <command>keactrl</command>
-        command is issued.  For example,
+        command is issued.  For example, the following
+        instructs <command>keactrl</command> to stop the
+        <command>kea-dhcp4</command> and <command>kea-dhcp6</command> servers
+        and leave the <command>kea-dhcp-ddns</command> server running:
 <screen>
 <userinput>$ keactrl stop -s dhcp4,dhcp6</userinput>
 </screen>
-        ... instructs <command>keactrl</command> to stop the
-        <command>kea-dhcp4</command> and <command>kea-dhcp6</command> servers
-        and leave the <command>kea-dhcp-ddns</command> running.
       </para>
 
       <para>
-        Similarly,
+        Similarly, the following
+        will only start the <command>kea-dhcp4</command> and
+        <command>kea-dhcp-ddns</command> servers and not
+        <command>kea-dhcp6</command>.
 <screen>
 <userinput>$ keactrl start -s dhcp4,dhcp_ddns</userinput>
 </screen>
-        ... will only start the <command>kea-dhcp4</command> and
-        <command>kea-dhcp-ddns</command> servers and not
-        <command>kea-dhcp6</command>.
       </para>
       <para>
         Note that the behavior of the <command>-s</command> switch