[#3831] ARM Updates

modified:   doc/sphinx/arm/agent.rst
modified:   doc/sphinx/arm/ddns.rst
modified:   doc/sphinx/arm/dhcp4-srv.rst

diff --git a/doc/sphinx/arm/agent.rst b/doc/sphinx/arm/agent.rst
index 0ace3cad7c7131495f403eb95cc2db0daf2fac05..1c5fd253d0817e1b648f26500cd9f85af6532388 100644 (file)
--- a/doc/sphinx/arm/agent.rst
+++ b/doc/sphinx/arm/agent.rst
@@ -150,6 +150,16 @@ for the DHCPv4 server and the CA (for that server) must match. Consult
 :ref:`d2-unix-ctrl-channel` to learn how the UNIX socket configuration is
 specified for the DHCPv4, DHCPv6, and D2 services.
 
+.. note::
+
+    As of Kea 2.7.9, control sockets may reside only in the directory
+    determined during compilation as ``"[kea-install-dir]/var/run/kea"``. This
+    path may be overridden at startup by setting the environment variable
+    ``KEA_CONTROL_SOCKET_DIR`` to the desired path.  If a path other than
+    this value is used in ``socket-name``, Kea will emit an error and refuse to
+    start or, if already running, log an unrecoverable error.  For ease of use in
+    simply omit the path component from ``socket-name`` entries.
+
 User contexts can store arbitrary data as long as they are in valid JSON
 syntax and their top-level element is a map (i.e. the data must be
 enclosed in curly brackets). Some hook libraries may expect specific

diff --git a/doc/sphinx/arm/ddns.rst b/doc/sphinx/arm/ddns.rst
index 129082c296721d50425fe1319feac839c2352134..a13b70f83cfea77233eba372742cbcdf7ed1a09f 100644 (file)
--- a/doc/sphinx/arm/ddns.rst
+++ b/doc/sphinx/arm/ddns.rst
@@ -326,7 +326,7 @@ Kea supports only one ``unix`` control socket in the "control-sockets" list.
 
 .. note::
 
-    As of Kea 2.7.9, control sockets may reside in the directory
+    As of Kea 2.7.9, control sockets may only reside in the directory
     determined during compilation as ``"[kea-install-dir]/var/run/kea"``. This
     path may be overridden at startup by setting the environment variable
     ``KEA_CONTROL_SOCKET_DIR`` to the desired path.  If a path other than

diff --git a/doc/sphinx/arm/dhcp4-srv.rst b/doc/sphinx/arm/dhcp4-srv.rst
index fcb071dab7f1bb3f1ea078c324360fe61b7b7bf6..1a480140b61a217d18d89faf31d69e7812ba52b2 100644 (file)
--- a/doc/sphinx/arm/dhcp4-srv.rst
+++ b/doc/sphinx/arm/dhcp4-srv.rst
@@ -7838,7 +7838,7 @@ Kea supports only one ``unix`` control socket in the "control-sockets" list.
 
 .. note::
 
-    As of Kea 2.7.9, control sockets may reside in the directory
+    As of Kea 2.7.9, control sockets may only reside in the directory
     determined during compilation as ``"[kea-install-dir]/var/run/kea"``. This
     path may be overridden at startup by setting the environment variable
     ``KEA_CONTROL_SOCKET_DIR`` to the desired path.  If a path other than