From: Tomek Mrugalski Date: Tue, 6 Aug 2019 16:44:01 +0000 (+0200) Subject: [#777,!464] Cosmetic improvments in .json files X-Git-Tag: Kea-1.6.0~41^2~160 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=97cea8ba40039cbf1b7cae6f9c0cbcadc2675036;p=thirdparty%2Fkea.git [#777,!464] Cosmetic improvments in .json files --- diff --git a/doc/sphinx/api/class-add.json b/doc/sphinx/api/class-add.json index 41fa4c30eb..611f1a490c 100644 --- a/doc/sphinx/api/class-add.json +++ b/doc/sphinx/api/class-add.json @@ -2,13 +2,11 @@ "avail": "1.5.0", "brief": [ "This command is used to create and add a new class to the existing", - " server configuration." + "server configuration." ], "cmd-comment": [ - "The next-server,", - " server-hostname and", - " boot-file-name are DHCPv4 specific. Only", - " one client class can be added with a single command. " + "The ``next-server``, ``server-hostname`` and ``boot-file-name`` are DHCPv4 specific. Only", + "one client class can be added with a single command. " ], "cmd-syntax": [ "{", @@ -31,7 +29,7 @@ "name": "class-add", "resp-comment": [ "The command will be successful (result 0), unless the", - " class name is a duplicate or another error occurs (result 1)." + "class name is a duplicate or another error occurs (result 1)." ], "resp-syntax": [ "{", @@ -43,4 +41,4 @@ "kea-dhcp4", "kea-dhcp6" ] -} \ No newline at end of file +} diff --git a/doc/sphinx/api/class-del.json b/doc/sphinx/api/class-del.json index 1a57ace456..069952392a 100644 --- a/doc/sphinx/api/class-del.json +++ b/doc/sphinx/api/class-del.json @@ -16,9 +16,9 @@ "name": "class-del", "resp-comment": [ "The command will return a result of 3 (empty) if the client", - " class doesn't exist. If the client class exists, the retured", - " result is 0 if the deletion was successful and the result is 1", - " if the deletion is unsuccessful." + "class doesn't exist. If the client class exists, the retured", + "result is 0 if the deletion was successful and the result is 1", + "if the deletion is unsuccessful." ], "resp-syntax": [ "{", @@ -30,4 +30,4 @@ "kea-dhcp4", "kea-dhcp6" ] -} \ No newline at end of file +} diff --git a/doc/sphinx/api/class-get.json b/doc/sphinx/api/class-get.json index 57aa2a9a22..00c9738d93 100644 --- a/doc/sphinx/api/class-get.json +++ b/doc/sphinx/api/class-get.json @@ -2,7 +2,7 @@ "avail": "1.5.0", "brief": [ "This command is used to return detailed information about an", - " existing client class." + "existing client class." ], "cmd-syntax": [ "{", @@ -17,12 +17,12 @@ "name": "class-get", "resp-comment": [ "The returned information depends on the DHCP server type,", - " i.e. some parameters are specific to DHCPv4 server. Also,", - " some parameters may not be returned if they are not set for", - " the client class. If the class with specified name doesn't", - " exist a result of 3 (empty) is returned. If the client class", - " is found, the result of 0 is returned. If there is an error", - " while processing the command, the result of 1 is returned." + "i.e. some parameters are specific to DHCPv4 server. Also,", + "some parameters may not be returned if they are not set for", + "the client class. If the class with specified name doesn't", + "exist a result of 3 (empty) is returned. If the client class", + "is found, the result of 0 is returned. If there is an error", + "while processing the command, the result of 1 is returned." ], "resp-syntax": [ "{", @@ -48,4 +48,4 @@ "kea-dhcp4", "kea-dhcp6" ] -} \ No newline at end of file +} diff --git a/doc/sphinx/api/class-list.json b/doc/sphinx/api/class-list.json index 0f62b286c9..36486cbfd3 100644 --- a/doc/sphinx/api/class-list.json +++ b/doc/sphinx/api/class-list.json @@ -2,7 +2,7 @@ "avail": "1.5.0", "brief": [ "This command is used to retrieve a list of all client", - " classes from the server configuration." + "classes from the server configuration." ], "cmd-comment": [ "This command includes no arguments." @@ -17,13 +17,13 @@ "name": "class-list", "resp-comment": [ "The returned list of classes merely contains their names.", - " In order to retrieve full information about one of these", - " classes use .", - " The returned result is 3 (empty) if no classes are found.", - " If the command is processed successfully and the list of", - " client classes is not empty, the result of 0 is returned.", - " If there is an error while processing the command, the", - " result of 1 is returned." + "In order to retrieve full information about one of these", + "classes use :ref:`command-class-get`.", + "The returned result is 3 (empty) if no classes are found.", + "If the command is processed successfully and the list of", + "client classes is not empty, the result of 0 is returned.", + "If there is an error while processing the command, the", + "result of 1 is returned." ], "resp-syntax": [ "{", @@ -45,4 +45,4 @@ "kea-dhcp4", "kea-dhcp6" ] -} \ No newline at end of file +} diff --git a/doc/sphinx/api/class-update.json b/doc/sphinx/api/class-update.json index 0c88c7fed6..dd8d67baf8 100644 --- a/doc/sphinx/api/class-update.json +++ b/doc/sphinx/api/class-update.json @@ -2,13 +2,11 @@ "avail": "1.5.0", "brief": [ "This command is used to update an existing client class in", - " the server configuration." + "the server configuration." ], "cmd-comment": [ - "The next-server,", - " server-hostname and", - " boot-file-name are DHCPv4 specific. Only", - " one client class can be updated with a single command. " + "The ``next-server``, ``server-hostname`` and ``boot-file-name`` are DHCPv4 specific. Only", + "one client class can be updated with a single command. " ], "cmd-syntax": [ "{", @@ -31,9 +29,9 @@ "name": "class-update", "resp-comment": [ "The command will return the result of 3 (empty) if the client", - " class doesn't exist. If the client class exists, the retured", - " result is 0 if the update was successful and the result is 1", - " if the update is unsuccessful." + "class doesn't exist. If the client class exists, the retured", + "result is 0 if the update was successful and the result is 1", + "if the update is unsuccessful." ], "resp-syntax": [ "{", @@ -45,4 +43,4 @@ "kea-dhcp4", "kea-dhcp6" ] -} \ No newline at end of file +} diff --git a/doc/sphinx/api/config-get.json b/doc/sphinx/api/config-get.json index 436bb4202e..2bee41388a 100644 --- a/doc/sphinx/api/config-get.json +++ b/doc/sphinx/api/config-get.json @@ -2,8 +2,8 @@ "avail": "1.2.0", "brief": [ "Retrieves the current configuration used by the server. The configuration", - " is roughtly equal to the configuration file, but includes additional", - " changes made by other commands and due to parameters inheritance." + "is roughtly equal to the configuration file, but includes additional", + "changes made by other commands and due to parameters inheritance." ], "cmd-comment": [ "This command takes no parameters." @@ -28,4 +28,4 @@ "kea-dhcp-ddns", "kea-ctrl-agent" ] -} \ No newline at end of file +} diff --git a/doc/sphinx/api/config-test.json b/doc/sphinx/api/config-test.json index 5f09d7caf5..6399ca2bfd 100644 --- a/doc/sphinx/api/config-test.json +++ b/doc/sphinx/api/config-test.json @@ -18,11 +18,11 @@ "description": "See ", "name": "config-test", "resp-syntax": [ - "{\"result\": 0, \"text\": \"Configuration seems sane...\" }", + "{ \"result\": 0, \"text\": \"Configuration seems sane...\" }", "", " or", "", - " {\"result\": 1, \"text\": \"unsupported parameter: BOGUS (:16:26)\" }" + "{ \"result\": 1, \"text\": \"unsupported parameter: BOGUS (:16:26)\" }" ], "support": [ "kea-dhcp4", @@ -30,4 +30,4 @@ "kea-dhcp-ddns", "kea-ctrl-agent" ] -} \ No newline at end of file +} diff --git a/doc/sphinx/api/config-write.json b/doc/sphinx/api/config-write.json index a723c43984..490dc7d28d 100644 --- a/doc/sphinx/api/config-write.json +++ b/doc/sphinx/api/config-write.json @@ -2,7 +2,7 @@ "avail": "1.2.0", "brief": [ "The config-write command instructs the Kea server to write its", - " current configuration to a file on disk." + "current configuration to a file on disk." ], "cmd-syntax": [ "{", @@ -20,4 +20,4 @@ "kea-dhcp-ddns", "kea-ctrl-agent" ] -} \ No newline at end of file +} diff --git a/doc/sphinx/api/ha-heartbeat.json b/doc/sphinx/api/ha-heartbeat.json index 67ddc8777c..c1eed190e6 100644 --- a/doc/sphinx/api/ha-heartbeat.json +++ b/doc/sphinx/api/ha-heartbeat.json @@ -2,7 +2,7 @@ "avail": "1.4.0", "brief": [ "This command is sent internally by Kea partner when operating", - " in High Availability (HA) mode. It will retrieve the server HA state and clock value." + "in High Availability (HA) mode. It will retrieve the server HA state and clock value." ], "cmd-syntax": [ "{", @@ -13,10 +13,10 @@ "hook": "high_availability", "name": "ha-heartbeat", "resp-comment": [ - "The response to this command is different from the typical command response. The response will include server state (see plus the current clock value." + "The response to this command is different from the typical command response. The response will include server state (see :ref:`ha-server-states`) plus the current clock value." ], "support": [ "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 92b5c48753..52b34e40f5 100644 --- a/doc/sphinx/api/ha-sync.json +++ b/doc/sphinx/api/ha-sync.json @@ -2,7 +2,7 @@ "avail": "1.4.0", "brief": [ "The command is issued to instruct the server running in HA mode to ", - " synchronize its local lease database with the selected peer." + "synchronize its local lease database with the selected peer." ], "cmd-syntax": [ "{", @@ -21,4 +21,4 @@ "kea-dhcp4", "kea-dhcp6" ] -} \ No newline at end of file +} diff --git a/doc/sphinx/api/lease4-wipe.json b/doc/sphinx/api/lease4-wipe.json index 4dee711f67..1685a6d1c9 100644 --- a/doc/sphinx/api/lease4-wipe.json +++ b/doc/sphinx/api/lease4-wipe.json @@ -5,10 +5,10 @@ ], "cmd-syntax": [ "{", - " \"command\": \"lease4-wipe\",", - " \"arguments\": {", - " \"subnet-id\": 44", - " }", + " \"command\": \"lease4-wipe\",", + " \"arguments\": {", + " \"subnet-id\": 44", + " }", "}" ], "description": "See ", @@ -17,4 +17,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 336ecdb882..a8fd13fe58 100644 --- a/doc/sphinx/api/lease6-add.json +++ b/doc/sphinx/api/lease6-add.json @@ -22,9 +22,10 @@ "name": "lease6-add", "resp-syntax": [ "{ \"result\": 0, \"text\": \"Lease added.\" }", - " { \"result\": 1, \"text\": \"missing parameter 'ip-address' (:3:19)\" }" + " or ", + "{ \"result\": 1, \"text\": \"missing parameter 'ip-address' (:3:19)\" }" ], "support": [ "kea-dhcp6" ] -} \ No newline at end of file +} diff --git a/doc/sphinx/api/lease6-bulk-apply.json b/doc/sphinx/api/lease6-bulk-apply.json index 7797f5cd4d..7f0e42dd47 100644 --- a/doc/sphinx/api/lease6-bulk-apply.json +++ b/doc/sphinx/api/lease6-bulk-apply.json @@ -8,35 +8,35 @@ ], "cmd-syntax": [ "{", - " \"command\": \"lease6-bulk-apply\",", - " \"arguments\": {", - " \"deleted-leases\": [", - " {", - " \"ip-address\": \"2001:db8:abcd::\",", - " \"type\": \"IA_PD\",", - " ...", - " },", - " {", - " \"ip-address\": \"2001:db8:abcd::234\",", - " \"type\": \"IA_NA\",", - " ...", - " }", - " ],", - " \"leases\": [", - " {", - " \"subnet-id\": 66,", - " \"ip-address\": \"2001:db8:cafe::\",", - " \"type\": \"IA_PD\",", - " ...", - " },", - " {", - " \"subnet-id\": 66,", - " \"ip-address\": \"2001:db8:abcd::333\",", - " \"type\": \"IA_NA\",", - " ...", - " }", - " ]", - " }", + " \"command\": \"lease6-bulk-apply\",", + " \"arguments\": {", + " \"deleted-leases\": [", + " {", + " \"ip-address\": \"2001:db8:abcd::\",", + " \"type\": \"IA_PD\",", + " ...", + " },", + " {", + " \"ip-address\": \"2001:db8:abcd::234\",", + " \"type\": \"IA_NA\",", + " ...", + " }", + " ],", + " \"leases\": [", + " {", + " \"subnet-id\": 66,", + " \"ip-address\": \"2001:db8:cafe::\",", + " \"type\": \"IA_PD\",", + " ...", + " },", + " {", + " \"subnet-id\": 66,", + " \"ip-address\": \"2001:db8:abcd::333\",", + " \"type\": \"IA_NA\",", + " ...", + " }", + " ]", + " }", "}" ], "hook": "lease_cmds", @@ -73,4 +73,4 @@ "support": [ "kea-dhcp6" ] -} \ No newline at end of file +} diff --git a/doc/sphinx/api/network6-del.json b/doc/sphinx/api/network6-del.json index 1e11982f59..022fc1f02e 100644 --- a/doc/sphinx/api/network6-del.json +++ b/doc/sphinx/api/network6-del.json @@ -5,7 +5,7 @@ ], "cmd-comment": [ "The network6-del command uses exactly the same syntax for", - " both the command and the response." + "both the command and the response." ], "cmd-syntax": [ "{", @@ -30,4 +30,4 @@ "support": [ "kea-dhcp6" ] -} \ No newline at end of file +} diff --git a/doc/sphinx/api/reservation-add.json b/doc/sphinx/api/reservation-add.json index 25e0ea43eb..fb3c11e791 100644 --- a/doc/sphinx/api/reservation-add.json +++ b/doc/sphinx/api/reservation-add.json @@ -1,10 +1,10 @@ { "avail": "1.2.0", "brief": [ - "adds a new host reservation. The reservation may include IPv4 address,", - " IPv6 addresses, IPv6 prefixes, various identifiers, a class", - " the client will be assigned to, DHCPv4 and DHCPv6 options and", - " more." + "Adds a new host reservation. The reservation may include IPv4 address,", + "IPv6 addresses, IPv6 prefixes, various identifiers, a class", + "the client will be assigned to, DHCPv4 and DHCPv6 options and", + "more." ], "cmd-comment": [ "Note the ip-address, client-id, next-server, server-hostname and", @@ -51,4 +51,4 @@ "kea-dhcp4", "kea-dhcp6" ] -} \ No newline at end of file +} diff --git a/doc/sphinx/api/shutdown.json b/doc/sphinx/api/shutdown.json index 6f4b8e1ad3..5ebab23016 100644 --- a/doc/sphinx/api/shutdown.json +++ b/doc/sphinx/api/shutdown.json @@ -5,7 +5,7 @@ ], "cmd-comment": [ "The server will respond with a confirmation that the shutdown", - " procedure has been initiated." + "procedure has been initiated." ], "cmd-syntax": [ "{", @@ -20,4 +20,4 @@ "kea-dhcp-ddns", "kea-ctrl-agent" ] -} \ No newline at end of file +} diff --git a/doc/sphinx/api/stat-lease4-get.json b/doc/sphinx/api/stat-lease4-get.json index f5f2a8f926..d0dc621275 100644 --- a/doc/sphinx/api/stat-lease4-get.json +++ b/doc/sphinx/api/stat-lease4-get.json @@ -2,7 +2,7 @@ "avail": "1.4.0", "brief": [ "The stat-lease4-get command fetches lease statistics for a range", - " of known IPv4 subnets." + "of known IPv4 subnets." ], "cmd-syntax": [ "{", @@ -34,4 +34,4 @@ "support": [ "kea-dhcp4" ] -} \ No newline at end of file +} diff --git a/doc/sphinx/api/stat-lease6-get.json b/doc/sphinx/api/stat-lease6-get.json index 4334dedcce..000f5fd075 100644 --- a/doc/sphinx/api/stat-lease6-get.json +++ b/doc/sphinx/api/stat-lease6-get.json @@ -2,7 +2,7 @@ "avail": "1.4.0", "brief": [ "The stat-lease6-get command fetches lease statistics for a range", - " of known IPv6 subnets." + "of known IPv6 subnets." ], "cmd-syntax": [ "{", @@ -35,4 +35,4 @@ "support": [ "kea-dhcp6" ] -} \ No newline at end of file +} diff --git a/doc/sphinx/api/version-get.json b/doc/sphinx/api/version-get.json index 5367573a46..22027e5099 100644 --- a/doc/sphinx/api/version-get.json +++ b/doc/sphinx/api/version-get.json @@ -2,8 +2,8 @@ "avail": "1.2.0", "brief": [ "The version-get command returns extended information about", - " Kea version. The returned string is the same as if Kea would", - " be run with -V command line option." + "Kea version. The returned string is the same as if Kea would", + "be run with ``-V`` command line option." ], "cmd-syntax": [ "{", @@ -18,4 +18,4 @@ "kea-dhcp-ddns", "kea-ctrl-agent" ] -} \ No newline at end of file +}