[#1115] Updated doc and added ChangeLog

modified:
    ChangeLog
    doc/sphinx/api/shutdown.json
    doc/sphinx/arm/ctrl-channel.rst

diff --git a/ChangeLog b/ChangeLog
index dda88b5ed58232a109ee70360504b4800fa35b94..b493e666c6b6fa7170d48fd5088f503ffe1bc0eb 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+1727.  [bug]           tmark
+       When shutting down due to lost backend database connetivity,
+       kea-dhcp4 and kea-dhcp6 processes will exit with a non-zero value.
+       This was temporarily altered by #1108. In addition, the "shutdown"
+       command now supports an "exit-value" argument.
+       (Gitlab #1115)
+
 1726.  [func]          razvan
        Handling SKIP and DROP state in hooks so that the same operation
        is not performed multiple times. Some hooks will throw exceptions

diff --git a/doc/sphinx/api/shutdown.json b/doc/sphinx/api/shutdown.json
index f3c05835bb48e1ce4a0ac8250d4b892973293462..0c6c8e73112c724e96ec82c81fdbbc66ddb4d072 100644 (file)
--- a/doc/sphinx/api/shutdown.json
+++ b/doc/sphinx/api/shutdown.json
@@ -9,6 +9,9 @@
     "cmd-syntax": [
         "{",
         "    \"command\": \"shutdown\"",
+        "    \"arguments\": {",
+        "        \"exit-value\": 123",
+        "    }",
         "}"
     ],
     "description": "See <xref linkend=\"command-shutdown\"/>",

diff --git a/doc/sphinx/arm/ctrl-channel.rst b/doc/sphinx/arm/ctrl-channel.rst
index 36ca31b126b7707f2934eeb8f5e4bf1f289d4e87..78b0f0d7254ebd4f3664e53b4190e242e4c76232 100644 (file)
--- a/doc/sphinx/arm/ctrl-channel.rst
+++ b/doc/sphinx/arm/ctrl-channel.rst
@@ -496,10 +496,15 @@ may look like this:
 
    {
        "command": "shutdown"
+       "arguments": {
+           "exit-value": 3
+       }
    }
 
 The server responds with a confirmation that the shutdown procedure has
-been initiated.
+been initiated.  The optional parameter, "exit-value", specifies the
+numeric value with which the server process will exit to the OS.  The
+default value is zero.
 
 .. _command-dhcp-disable: