From: Razvan Becheriu <razvan@isc.org>
Date: Thu, 8 Aug 2019 18:18:38 +0000 (+0300)
Subject: [#810, !471] fixed sphinx docs
X-Git-Tag: Kea-1.6.0~41^2~48
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8ffc32fbb29f5369c480a261cc488737e327636c;p=thirdparty%2Fkea.git

[#810, !471] fixed sphinx docs
---

diff --git a/doc/sphinx/api/cache-get-by-id.json b/doc/sphinx/api/cache-get-by-id.json
index 10a24a990a..c6cfa3658d 100644
--- a/doc/sphinx/api/cache-get-by-id.json
+++ b/doc/sphinx/api/cache-get-by-id.json
@@ -9,13 +9,14 @@
         "    \"arguments\": {",
         "        \"hw-address\": \"01:02:03:04:05:06\"",
         "    }"
+        "}"
     ],
     "hook": "host_cache",
     "name": "cache-get-by-id",
     "resp-syntax": [
         "{",
-        "    \"result\": 0",
-        "    \"text\": \"2 entries returned.\"",
+        "    \"result\": 0,",
+        "    \"text\": \"2 entries returned.\",",
         "    \"arguments\": <list of host reservations>",
         "}"
     ],
@@ -23,4 +24,4 @@
         "kea-dhcp4",
         "kea-dhcp6"
     ]
-}
\ No newline at end of file
+}
diff --git a/doc/sphinx/api/cache-get.json b/doc/sphinx/api/cache-get.json
index 3c27a11218..af8b020180 100644
--- a/doc/sphinx/api/cache-get.json
+++ b/doc/sphinx/api/cache-get.json
@@ -7,8 +7,8 @@
     "name": "cache-get",
     "resp-syntax": [
         "{",
-        "    \"result\": 0",
-        "    \"text\": \"123 entries returned.\"",
+        "    \"result\": 0,",
+        "    \"text\": \"123 entries returned.\",",
         "    \"arguments\": <list of host reservations>",
         "}"
     ],
@@ -16,4 +16,4 @@
         "kea-dhcp4",
         "kea-dhcp6"
     ]
-}
\ No newline at end of file
+}
diff --git a/doc/sphinx/api/cache-insert.json b/doc/sphinx/api/cache-insert.json
index 64c9bc6565..c8354e910e 100644
--- a/doc/sphinx/api/cache-insert.json
+++ b/doc/sphinx/api/cache-insert.json
@@ -49,4 +49,4 @@
         "kea-dhcp4",
         "kea-dhcp6"
     ]
-}
\ No newline at end of file
+}
diff --git a/doc/sphinx/api/cache-size.json b/doc/sphinx/api/cache-size.json
index b5340733d4..0b44bdeccc 100644
--- a/doc/sphinx/api/cache-size.json
+++ b/doc/sphinx/api/cache-size.json
@@ -7,8 +7,8 @@
     "name": "cache-size",
     "resp-syntax": [
         "{",
-        "    \"result\": 0",
-        "    \"text\": \"123 entries.\"",
+        "    \"result\": 0,",
+        "    \"text\": \"123 entries.\",",
         "    \"arguments\": { \"size\": 123 }",
         "}"
     ],
@@ -16,4 +16,4 @@
         "kea-dhcp4",
         "kea-dhcp6"
     ]
-}
\ No newline at end of file
+}
diff --git a/doc/sphinx/api/class-add.json b/doc/sphinx/api/class-add.json
index 611f1a490c..69a6529c73 100644
--- a/doc/sphinx/api/class-add.json
+++ b/doc/sphinx/api/class-add.json
@@ -34,7 +34,7 @@
     "resp-syntax": [
         "{",
         "    \"result\": 0,",
-        "    \"text\": \"Class '<class-name>' added.\",",
+        "    \"text\": \"Class '<class-name>' added.\"",
         "}"
     ],
     "support": [
diff --git a/doc/sphinx/api/class-list.json b/doc/sphinx/api/class-list.json
index 36486cbfd3..4f80828c67 100644
--- a/doc/sphinx/api/class-list.json
+++ b/doc/sphinx/api/class-list.json
@@ -28,7 +28,7 @@
     "resp-syntax": [
         "{",
         "    \"result\": 0,",
-        "    \"text\": \"<number of> classes found\",",
+        "    \"text\": \"'<number of>' classes found\",",
         "    \"arguments\": {",
         "        \"client-classes\": [",
         "            {",
diff --git a/doc/sphinx/api/class-update.json b/doc/sphinx/api/class-update.json
index dd8d67baf8..acefa18024 100644
--- a/doc/sphinx/api/class-update.json
+++ b/doc/sphinx/api/class-update.json
@@ -36,7 +36,7 @@
     "resp-syntax": [
         "{",
         "    \"result\": 0,",
-        "    \"text\": \"Class '<class-name>' updated.\",",
+        "    \"text\": \"Class '<class-name>' updated.\"",
         "}"
     ],
     "support": [
diff --git a/doc/sphinx/api/config-get.json b/doc/sphinx/api/config-get.json
index 2bee41388a..6c4f8231fe 100644
--- a/doc/sphinx/api/config-get.json
+++ b/doc/sphinx/api/config-get.json
@@ -18,7 +18,7 @@
         "{",
         "    \"result\": <integer>,",
         "    \"arguments\": {",
-        "        <JSON configuration here, starting with Dhcp4, Dhcp6, or Control-agent object>",
+        "        <Dhcp4, Dhcp6, or Control-agent object>: <JSON configuration here> ",
         "    }",
         "}"
     ],
diff --git a/doc/sphinx/api/config-set.json b/doc/sphinx/api/config-set.json
index 02fc74a7cf..3270c20955 100644
--- a/doc/sphinx/api/config-set.json
+++ b/doc/sphinx/api/config-set.json
@@ -4,13 +4,13 @@
         "The config-set command instructs the server to replace its current configuration with the new configuration supplied in the command's arguments."
     ],
     "cmd-comment": [
-        "where `<server>` is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\""
+        "where '<server>' is the configuration element name for a given server such as \"Dhcp4\" or \"Dhcp6\""
     ],
     "cmd-syntax": [
         "{",
         "    \"command\": \"config-set\",",
         "    \"arguments\":  {",
-        "        \"<server>\": {",
+        "        \"'<server>'\": {",
         "        }",
         "     }",
         "}"
@@ -18,11 +18,11 @@
     "description": "See <xref linkend=\"command-config-set\"/>",
     "name": "config-set",
     "resp-syntax": [
-        "    {\"result\": 0, \"text\": \"Configuration successful.\" }",
+        "{\"result\": 0, \"text\": \"Configuration successful.\" }",
         "",
-        "    or",
+        "or",
         "",
-        "    {\"result\": 1, \"text\": \"unsupported parameter: BOGUS (<string>:16:26)\" }"
+        "{\"result\": 1, \"text\": \"unsupported parameter: BOGUS (<string>:16:26)\" }"
     ],
     "support": [
         "kea-dhcp4",
diff --git a/doc/sphinx/api/config-test.json b/doc/sphinx/api/config-test.json
index 335d06e9db..c77f1697e8 100644
--- a/doc/sphinx/api/config-test.json
+++ b/doc/sphinx/api/config-test.json
@@ -10,7 +10,7 @@
         "{",
         "    \"command\": \"config-test\",",
         "    \"arguments\":  {",
-        "        \"<server>\": {",
+        "        \"'<server>'\": {",
         "        }",
         "     }",
         "}"
@@ -20,7 +20,7 @@
     "resp-syntax": [
         "{ \"result\": 0, \"text\": \"Configuration seems sane...\" }",
         "",
-        "    or",
+        "or",
         "",
         "{ \"result\": 1, \"text\": \"unsupported parameter: BOGUS (<string>:16:26)\" }"
     ],
diff --git a/doc/sphinx/api/ha-heartbeat.json b/doc/sphinx/api/ha-heartbeat.json
index c1eed190e6..bfac1099e7 100644
--- a/doc/sphinx/api/ha-heartbeat.json
+++ b/doc/sphinx/api/ha-heartbeat.json
@@ -6,7 +6,7 @@
     ],
     "cmd-syntax": [
         "{",
-        "    \"command\": \"ha-heartbeat\",",
+        "    \"command\": \"ha-heartbeat\"",
         "    }"
     ],
     "description": "See <xref linkend=\"ha-server-states\"/>",
diff --git a/doc/sphinx/api/ha-scopes.json b/doc/sphinx/api/ha-scopes.json
index 889961d593..c8aca2dd41 100644
--- a/doc/sphinx/api/ha-scopes.json
+++ b/doc/sphinx/api/ha-scopes.json
@@ -9,10 +9,11 @@
     "cmd-syntax": [
         "{",
         "    \"command\": \"ha-scopes\",",
-        "    \"service\": [ <service, typically \"dhcp4\" or \"dhcp6\"> ],",
+        "    \"service\": [ <service, typically 'dhcp4' or 'dhcp6'> ],",
         "    \"arguments\": {",
         "        \"scopes\": [ \"HA_server1\", \"HA_server2\" ]",
         "    }"
+        "}"
     ],
     "description": "See <xref linkend=\"command-ha-scopes\"/>",
     "hook": "high_availability",
@@ -21,4 +22,4 @@
         "kea-dhcp4",
         "kea-dhcp6"
     ]
-}
\ No newline at end of file
+}
diff --git a/doc/sphinx/api/ha-sync.json b/doc/sphinx/api/ha-sync.json
index 52b34e40f5..2c1fa9dad7 100644
--- a/doc/sphinx/api/ha-sync.json
+++ b/doc/sphinx/api/ha-sync.json
@@ -7,7 +7,7 @@
     "cmd-syntax": [
         "{",
         "    \"command\": \"ha-sync\",",
-        "    \"service\": [ <service affected: \"dhcp4\" or \"dhcp6\" ],",
+        "    \"service\": [ <service affected: 'dhcp4' or 'dhcp6'> ],",
         "    \"arguments\": {",
         "        \"server-name\": <name of the partner server>,",
         "        \"max-period\": <integer, in seconds>",
diff --git a/doc/sphinx/api/lease4-add.json b/doc/sphinx/api/lease4-add.json
index 27e079f721..e9b701f81f 100644
--- a/doc/sphinx/api/lease4-add.json
+++ b/doc/sphinx/api/lease4-add.json
@@ -21,4 +21,4 @@
     "support": [
         "kea-dhcp4"
     ]
-}
\ No newline at end of file
+}
diff --git a/doc/sphinx/api/lease4-get-all.json b/doc/sphinx/api/lease4-get-all.json
index 5c33b9d19d..f8eb99f999 100644
--- a/doc/sphinx/api/lease4-get-all.json
+++ b/doc/sphinx/api/lease4-get-all.json
@@ -8,7 +8,7 @@
     ],
     "cmd-syntax": [
         "{",
-        "    \"command\": \"lease4-get-all\"",
+        "    \"command\": \"lease4-get-all\",",
         "    \"arguments\": \"subnets\"",
         "}"
     ],
@@ -18,4 +18,4 @@
     "support": [
         "kea-dhcp4"
     ]
-}
\ No newline at end of file
+}
diff --git a/doc/sphinx/api/lease6-add.json b/doc/sphinx/api/lease6-add.json
index a8fd13fe58..344e7841f5 100644
--- a/doc/sphinx/api/lease6-add.json
+++ b/doc/sphinx/api/lease6-add.json
@@ -22,7 +22,7 @@
     "name": "lease6-add",
     "resp-syntax": [
         "{ \"result\": 0, \"text\": \"Lease added.\" }",
-        " or ",
+        "or",
         "{ \"result\": 1, \"text\": \"missing parameter 'ip-address' (<string>:3:19)\" }"
     ],
     "support": [
diff --git a/doc/sphinx/api/lease6-bulk-apply.json b/doc/sphinx/api/lease6-bulk-apply.json
index 7f0e42dd47..77b223555a 100644
--- a/doc/sphinx/api/lease6-bulk-apply.json
+++ b/doc/sphinx/api/lease6-bulk-apply.json
@@ -48,7 +48,7 @@
         " {",
         "    {",
         "        \"result\": 0,",
-        "        \"text\": IPv6 leases bulk apply completed.",
+        "        \"text\": \"IPv6 leases bulk apply completed.\",",
         "        \"arguments\": {",
         "            \"failed-deleted-leases\": [",
         "                {",
@@ -62,7 +62,7 @@
         "                {",
         "                    \"ip-address\": \"2001:db8:cafe::\",",
         "                    \"type\": \"IA_PD\",",
-        "                    \"result\" <control result>,",
+        "                    \"result\": <control result>,",
         "                    \"error-message\": <error message>",
         "                }",
         "            ]",
diff --git a/doc/sphinx/api/network4-get.json b/doc/sphinx/api/network4-get.json
index a85de53d4d..a386286e13 100644
--- a/doc/sphinx/api/network4-get.json
+++ b/doc/sphinx/api/network4-get.json
@@ -40,8 +40,8 @@
         "                    // many other subnet specific details here",
         "                },",
         "                {",
-        "                    \"id\": 6,",
         "                    \"subnet\": \"192.0.3.0/31\",",
+        "                    \"id\": 6,",
         "                    // many other subnet specific details here",
         "                }",
         "            ],",
@@ -54,4 +54,4 @@
     "support": [
         "kea-dhcp4"
     ]
-}
\ No newline at end of file
+}
diff --git a/doc/sphinx/api/network6-get.json b/doc/sphinx/api/network6-get.json
index 10dbfd6ebe..893bb17cb9 100644
--- a/doc/sphinx/api/network6-get.json
+++ b/doc/sphinx/api/network6-get.json
@@ -40,8 +40,8 @@
         "                    // many other subnet specific details here",
         "                },",
         "                {",
-        "                    \"id\": 6,",
         "                    \"subnet\": \"192.0.3.0/31\",",
+        "                    \"id\": 6,",
         "                    // many other subnet specific details here",
         "                }",
         "            ],",
@@ -54,4 +54,4 @@
     "support": [
         "kea-dhcp6"
     ]
-}
\ No newline at end of file
+}
diff --git a/doc/sphinx/api/remote-global-parameter4-set.json b/doc/sphinx/api/remote-global-parameter4-set.json
index 469026f0ab..c1e5dbba29 100644
--- a/doc/sphinx/api/remote-global-parameter4-set.json
+++ b/doc/sphinx/api/remote-global-parameter4-set.json
@@ -8,7 +8,7 @@
     ],
     "cmd-syntax": [
         "{",
-        "    \"command\": \"remote-global-parameter4-set\"",
+        "    \"command\": \"remote-global-parameter4-set\",",
         "    \"arguments\": {",
         "        \"parameters\": {",
         "            <first parameter name>: <first parameter value>,",
diff --git a/doc/sphinx/api/remote-network4-del.json b/doc/sphinx/api/remote-network4-del.json
index 28be9a35db..5721162e80 100644
--- a/doc/sphinx/api/remote-network4-del.json
+++ b/doc/sphinx/api/remote-network4-del.json
@@ -15,7 +15,7 @@
         "                \"name\": <shared network name>",
         "            }",
         "        ],",
-        "        \"subnets-action\": \"keep\" | \"delete\",",
+        "        \"subnets-action\": '<'keep' | 'delete'>',",
         "        \"remote\": {",
         "            <specification of the database to connect to>",
         "        }",