From: Stephen Morris <stephen@isc.org>
Date: Fri, 12 Aug 2016 11:00:39 +0000 (+0100)
Subject: [4489] Minor edits to documentation
X-Git-Tag: trac4631_base~9^2~8
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=134a55c708212a1d55c9b5eb9660da6590c93835;p=thirdparty%2Fkea.git

[4489] Minor edits to documentation
---

diff --git a/doc/guide/admin.xml b/doc/guide/admin.xml
index ccfe991d77..e5decedaf0 100644
--- a/doc/guide/admin.xml
+++ b/doc/guide/admin.xml
@@ -714,7 +714,7 @@ $ <userinput>kea-admin lease-upgrade cql -n <replaceable>database-name</replacea
       the read only mode.
       Sections <xref linkend="read-only-database-configuration4"/> and
       <xref linkend="read-only-database-configuration6"/> describe when
-      such configuration may be desired and how to configure Kea to
+      such configuration may be reqired and how to configure Kea to
       operate using read only host database.
       </para>
     </section>
diff --git a/doc/guide/dhcp4-srv.xml b/doc/guide/dhcp4-srv.xml
index ebf5aa6ae8..fa2646efee 100644
--- a/doc/guide/dhcp4-srv.xml
+++ b/doc/guide/dhcp4-srv.xml
@@ -541,10 +541,10 @@ If a timeout is given though, it should be an integer greater than zero.
 </section>
 
 <section id="read-only-database-configuration4">
-<title>Using Read Only Databases for Host Reservations</title>
+<title>Using Read-Only Databases for Host Reservations</title>
 <para>
-In some deployments the database user, which name is specified in the database backend
-configuration, may not have write privileges to the database. This is often
+In some deployments the database user whose name is specified in the database backend
+configuration may not have write privileges to the database. This is often
 required by the policy within a given network to secure the data from being
 unintentionally modified. In many cases administrators have inventory databases
 deployed, which contain substantially more information about the hosts than
@@ -552,13 +552,13 @@ static reservations assigned to them. The inventory database can be used to crea
 a view of a Kea hosts database and such view is often read only.
 </para>
 <para>
-Kea host database backends operate with implicit configuration to both read
-from and write to the database. If the host database is read only for the
-particular user, the backend will fail to start and consequently the server
-will refuse to start/reconfigure. If the administrator intends to use the
-read only host database for retrieving reservations for clients, to assign
-specific addresses and options, it is possible to explicitly configure
-Kea to start in "read-only" mode. This is controlled by the
+Kea host database backends operate with an implicit configuration to both
+read from and write to the database. If the database user does not have
+write access to the host database, the backend will fail to start and the
+server will refuse to start (or reconfigure). However, if access to a read
+only host database is required for retrieving reservations for clients
+and/or assign specific addresses and options, it is possible to explicitly
+configure Kea to start in "read-only" mode. This is controlled by the
 <command>readonly</command> boolean parameter as follows:
 <screen>
 "Dhcp4": { "hosts-database": { <userinput>"readonly": true</userinput>, ... }, ... }
diff --git a/doc/guide/dhcp6-srv.xml b/doc/guide/dhcp6-srv.xml
index 0b63c3a42b..444b95ebe8 100644
--- a/doc/guide/dhcp6-srv.xml
+++ b/doc/guide/dhcp6-srv.xml
@@ -542,10 +542,10 @@ If a timeout is given though, it should be an integer greater than zero.
 </section>
 
 <section id="read-only-database-configuration6">
-<title>Using Read Only Databases for Host Reservations</title>
+<title>Using Read-Only Databases for Host Reservations</title>
 <para>
-In some deployments the database user, which name is specified in the database backend
-configuration, may not have write privileges to the database. This is often
+In some deployments the database user whose name is specified in the database backend
+configuration may not have write privileges to the database. This is often
 required by the policy within a given network to secure the data from being
 unintentionally modified. In many cases administrators have inventory databases
 deployed, which contain substantially more information about the hosts than
@@ -553,16 +553,16 @@ static reservations assigned to them. The inventory database can be used to crea
 a view of a Kea hosts database and such view is often read only.
 </para>
 <para>
-Kea host database backends operate with implicit configuration to both read from
-and write to the database. If the host database is read only for the
-particular user, the backend will fail to start and consequently the server
-will refuse to start/reconfigure. If the administrator intends to use the
-read only host database for retrieving reservations for clients, to assign
-specific addresses and options, it is possible to explicitly configure
-Kea to start in "read-only" mode. This is controlled by the
+Kea host database backends operate with an implicit configuration to both
+read from and write to the database. If the database user does not have
+write access to the host database, the backend will fail to start and the
+server will refuse to start (or reconfigure). However, if access to a read
+only host database is required for retrieving reservations for clients
+and/or assign specific addresses and options, it is possible to explicitly
+configure Kea to start in "read-only" mode. This is controlled by the
 <command>readonly</command> boolean parameter as follows:
 <screen>
-"Dhcp4": { "hosts-database": { <userinput>"readonly": true</userinput>, ... }, ... }
+"Dhcp6": { "hosts-database": { <userinput>"readonly": true</userinput>, ... }, ... }
 </screen>
 Setting this parameter to <userinput>false</userinput> would configure the
 database backend to operate in "read-write" mode, which is also a default