From: Francis Dupont <fdupont@isc.org>
Date: Thu, 11 Jun 2015 10:59:12 +0000 (+0200)
Subject: [3732] Applied #3732 review comments (doc clean up, add KEA_ to the msgq socket file... 
X-Git-Tag: trac3732a_base~3^2~1
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=6df2818a569c7a797b685a2c879049cf86f0e2ae;p=thirdparty%2Fkea.git

[3732] Applied #3732 review comments (doc clean up, add KEA_ to the msgq socket file env var)
---

diff --git a/doc/devel/config-backend.dox b/doc/devel/config-backend.dox
index 5e41dd8d44..8d5468065e 100644
--- a/doc/devel/config-backend.dox
+++ b/doc/devel/config-backend.dox
@@ -44,10 +44,9 @@ backend that reads a JSON configuration file from disk, it decided to
 make it easy for others to use different backends.
 
 While ISC currently (May 2015) maintains only one configuration backend
-(a JSON file read from disk), there may be other organizations (e.g.
-the Bundy project community) that will maintain other backends. It is quite
-possible that additional backends (e.g. using LDAP or XML) will be
-developed and maintained by other organizations.
+(a JSON file read from disk), it is quite possible that additional backends
+(e.g. using LDAP or XML) will be developed in the future by ISC or other
+organizations.
 
 @section configBackendAdding How to Add a New Configuration Backend
 
diff --git a/doc/guide/config.xml b/doc/guide/config.xml
index a98772f9a3..3d12cad747 100644
--- a/doc/guide/config.xml
+++ b/doc/guide/config.xml
@@ -6,8 +6,10 @@
 <chapter id="kea-config">
   <title>Kea configuration</title>
 
-  <para>The following section describe details of the only configuration
-    backend which can be configured and used.</para>
+  <para>Kea is designed to allow different methods by which it can be
+    configured, each method being implemented by a component known as a
+    configuration backend.  At present, only one such backend is
+    available, that allowing configuration by means of a JSON file.</para>
 
   <section id="json-backend">
     <title>JSON configuration backend</title>
diff --git a/src/bin/d2/d2.dox b/src/bin/d2/d2.dox
index fa20b697f3..63d1d0c3a8 100644
--- a/src/bin/d2/d2.dox
+++ b/src/bin/d2/d2.dox
@@ -54,7 +54,6 @@ an application process class derived from isc::d2::DProcess. These services incl
     - Command line argument handling
     - Process instantiation and initialization
     - Support for stand-alone execution
-    - Support for integrated operation
     - Process event loop invocation and shutdown
 
     It creates and manages an instance of isc::d2::DProcessBase.  The CPL is
@@ -207,11 +206,8 @@ in the diagram below:
 - isc::d2::D2Controller - entry point for running D2, it processes command line
 options, starts and controls the application process, @c D2Process.
 
-There were two implementations of D2Controller, today the only available
-form is JSON.
-
-- isc::d2::D2Process - creates and manages D2's primary resources and implements
-the main event loop described in @ref d2EventLoop.
+- isc::d2::D2Process - creates and manages D2's primary resources and
+implements the main event loop described in @ref d2EventLoop.
 
 - isc::d2::D2CfgMgr - creates, updates, and provides access to D2's application
 configuration which is embodied by @c D2CfgContext.
diff --git a/src/bin/dhcp4/dhcp4.dox b/src/bin/dhcp4/dhcp4.dox
index 9364e8d175..6288f52c1f 100644
--- a/src/bin/dhcp4/dhcp4.dox
+++ b/src/bin/dhcp4/dhcp4.dox
@@ -29,10 +29,6 @@ DHCPv4 server component does not support direct traffic (relayed
 only), as support for transmission to hosts without IPv4 address
 assigned is not implemented in IfaceMgr yet.
 
-@section dhcpv4Session
-
-No longer applicable.
-
 @section dhcpv4ConfigParser Configuration Parser in DHCPv4
 
 This parser follows exactly the same logic as its DHCPv6 counterpart.
diff --git a/src/bin/dhcp6/dhcp6.dox b/src/bin/dhcp6/dhcp6.dox
index cf0349f4fc..6fb191f1f6 100644
--- a/src/bin/dhcp6/dhcp6.dox
+++ b/src/bin/dhcp6/dhcp6.dox
@@ -28,10 +28,6 @@
  DHCPv6 server component does not support relayed traffic yet, as
  support for relay decapsulation is not implemented yet.
 
- @section dhcpv6Session
-
- No longer applicable.
-
  @section dhcpv6ConfigParser Configuration Parser in DHCPv6
 
  \note With the implementation of the Kea ticket #3534 we're moving away from
diff --git a/src/lib/cc/session.cc b/src/lib/cc/session.cc
index a46fb18f77..f8cc2c4aa4 100644
--- a/src/lib/cc/session.cc
+++ b/src/lib/cc/session.cc
@@ -309,10 +309,10 @@ public:
 void
 Session::establish(const char* socket_file) {
     if (socket_file == NULL) {
-        socket_file = getenv("MSGQ_SOCKET_FILE");
+        socket_file = getenv("KEA_MSGQ_SOCKET_FILE");
     }
     if (socket_file == NULL) {
-        socket_file = MSGQ_SOCKET_FILE;
+        socket_file = KEA_MSGQ_SOCKET_FILE;
     }
 
     impl_->establish(*socket_file);
diff --git a/src/lib/cc/session_config.h.pre.in b/src/lib/cc/session_config.h.pre.in
index 96ff421d43..91c26c0490 100644
--- a/src/lib/cc/session_config.h.pre.in
+++ b/src/lib/cc/session_config.h.pre.in
@@ -1,2 +1,2 @@
-#define MSGQ_SOCKET_FILE "@@LOCALSTATEDIR@@/@PACKAGE@/msgq_socket"
+#define KEA_MSGQ_SOCKET_FILE "@@LOCALSTATEDIR@@/@PACKAGE@/kea_msgq_socket"