]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[master] Several fixes to the documentation following 1.5.0 sanity checks.
authorMarcin Siodelski <marcin@isc.org>
Thu, 13 Dec 2018 14:58:54 +0000 (15:58 +0100)
committerMarcin Siodelski <marcin@isc.org>
Thu, 13 Dec 2018 14:59:11 +0000 (15:59 +0100)
Okayed on jabber.

doc/guide/config.xml
doc/guide/dhcp4-srv.xml
doc/guide/dhcp6-srv.xml
doc/guide/install.xml

index 4613d8360c8602bb9d7da46174cdcc6d0f6a6d4a..a6c8d92aaeab09363e2cbdc8b737b1a751018c72 100644 (file)
 <chapter xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="kea-config">
   <title>Kea Configuration</title>
 
-  <para>Kea is using JSON structures to handle configuration. Previously
-  we there was a concept of other configuration backends, but that never was
-  implemented and the idea was abandoned.</para>
+  <para>Kea is using JSON structures to represent servers' configurations.
+  The following sections describe how the configuration structures are
+  organized.
+  </para>
 
   <section xml:id="json">
     <title>JSON Configuration</title>
     <para>JSON is notation used throughout the Kea project. The most obvious
-    usage is for configuration file, but it is also used for sending commands
+    usage is for the configuration file, but it is also used for sending commands
     over Management API (see <xref linkend="ctrl-channel"/>) and for
     communicating between DHCP servers and DDNS update daemon.</para>
 
     <para>Typical usage assumes that the servers are started from the command line
     (either directly or using a script, e.g. <filename>keactrl</filename>).
-    The JSON backend uses certain signals to influence Kea. The
-    configuration file is specified upon startup using the -c parameter.</para>
+    The configuration file is specified upon startup using the -c parameter.</para>
 
     <section xml:id="json-format">
       <title>JSON Syntax</title>
index 485a60fe06eb023ba7f35fd41264016eee974f46..88b4ca6916b4e3d23fbdbbc1c546cde5a67554c5 100644 (file)
@@ -139,11 +139,9 @@ strings <userinput>path</userinput>/kea-dhcp4 | sed -n 's/;;;; //p'
 <section>
   <title>Introduction</title>
       <para>
-        This section explains how to configure the DHCPv4 server using the
-        Kea configuration backend. (Kea configuration using any other
-        backends is outside of scope of this document.) Before DHCPv4
-        is started, its configuration file has to be created. The
-        basic configuration is as follows:
+        This section explains how to configure the DHCPv4 server using a
+        configuration file. Before DHCPv4 is started, its configuration
+        file has to be created. The basic configuration is as follows:
 <screen>
 {
 # DHCPv4 configuration starts in this line
@@ -310,9 +308,9 @@ In some cases in may be preferable to use more compact notation.
 
 <para>After all the parameters have been specified, we have two contexts open:
 global and Dhcp4, hence we need two closing curly brackets to close them.
-In a real life configuration file there most likely would be additional
-components defined such as Logging or DhcpDdns, so the closing brace would
-be followed by a comma and another object definition.</para>
+In a real life configuration file there most likely would be an additional
+component defined such as Logging, so the closing brace would be followed
+by a comma and another object definition.</para>
 </section>
 
 <section>
index 2b202657ce28d56b350bec8ac684e6687628dbc7..4262ca767659047a0887546d70c424377a78e080 100644 (file)
@@ -139,11 +139,9 @@ strings <userinput>path</userinput>/kea-dhcp6 | sed -n 's/;;;; //p'
 <section>
   <title>Introduction</title>
       <para>
-        This section explains how to configure the DHCPv6 server using the
-        Kea configuration backend. (Kea configuration using any other
-        backends is outside of scope of this document.) Before DHCPv6
-        is started, its configuration file has to be created. The
-        basic configuration is as follows:
+        This section explains how to configure the DHCPv6 server using a
+        configuration file. Before DHCPv6 is started, its configuration
+        file has to be created. The basic configuration is as follows:
 <screen>
 {
 # DHCPv6 configuration starts on the next line
@@ -303,8 +301,8 @@ In some cases in may be preferable to use more compact notation.
 <para>After all parameters are specified, we have two contexts open:
 global and Dhcp6, hence we need two closing curly brackets to close them.
 In a real life configuration file there most likely would be additional
-components defined such as Logging or DhcpDdns, so the closing brace would
-be followed by a comma and another object definition.</para>
+components defined such as Logging, so the closing brace would be followed
+by a comma and another object definition.</para>
 </section>
 
 <section>
index 88de6fb96f7f892066f8f34c1238915cc0835686..531af5c240cd1c089321a67a4873d71a7959cc2f 100644 (file)
@@ -596,7 +596,7 @@ Debian and Ubuntu:
           (and thus in the shell path) you do not need to supply its path.
           If it does not work (e.g. no pkg-config, package not available in
           pkg-config with the cassandra name), you can still use
-          the <command>cql_config</command> script in tools/ as describe below.
+          the <command>cql_config</command> script in tools/ as described below.
         </para>
         <para>
           Download and compile cpp-driver from DataStax. For details regarding
@@ -615,14 +615,16 @@ $ <userinput>make</userinput>
         <para>
           As of June 2016, cpp-driver does not include cql_config script
           yet. Work is in progress to contribute such a script to the cpp-driver
-          project but, until that is complete, intermediate steps that need to
+          project but, until that is complete, intermediate steps need to
           be conducted. A cql_config script is present in the tools/ directory
           of the Kea sources. Before using it, please create a
           cql_config_defines.sh in the same directory (there is an example in
           cql_config_define.sh.sample available, you may copy it over to
           cql_config_defines.sh and edit path specified in it) and change the
           environment variable CPP_DRIVER_PATH to point to the directory, where
-          cpp-driver sources are located.
+          cpp-driver sources are located. Make sure that appropriate access
+          rights are set on this file. It should be executable by the system
+          user building Kea.
         </para>
         <para>
           Build and install Kea as described in <xref linkend="installation"/>, with