From: Suzanne Goldlust Date: Fri, 9 Aug 2019 21:16:47 +0000 (-0400) Subject: Fix grammar, typos, a few JSON errors X-Git-Tag: Kea-1.6.0~41^2~42 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=cb4a21545ff17350e64f234ea67107eda7ecad40;p=thirdparty%2Fkea.git Fix grammar, typos, a few JSON errors --- diff --git a/doc/sphinx/api/build-report.json b/doc/sphinx/api/build-report.json index fb3d25f457..39ed952075 100644 --- a/doc/sphinx/api/build-report.json +++ b/doc/sphinx/api/build-report.json @@ -1,11 +1,11 @@ { "avail": "1.2.0", "brief": [ - "Returns a list of compilation options that this particular binary was built with" + "This command returns the list of compilation options that this particular binary was built with." ], "cmd-syntax": [ "{", - " \"command\": \"build-report\"", + " \"command\": \"build-report\",", "}" ], "name": "build-report", @@ -24,4 +24,4 @@ "kea-dhcp-ddns", "kea-ctrl-agent" ] -} \ No newline at end of file +} diff --git a/doc/sphinx/api/cache-get-by-id.json b/doc/sphinx/api/cache-get-by-id.json index 91d5160a8a..14c0b454ab 100644 --- a/doc/sphinx/api/cache-get-by-id.json +++ b/doc/sphinx/api/cache-get-by-id.json @@ -1,7 +1,7 @@ { "avail": "1.6.0", "brief": [ - "Returns entries matching the given identifier from the host cache." + "This command returns entries matching the given identifier from the host cache." ], "cmd-syntax": [ "{", diff --git a/doc/sphinx/api/cache-get.json b/doc/sphinx/api/cache-get.json index af8b020180..b7af01d0f2 100644 --- a/doc/sphinx/api/cache-get.json +++ b/doc/sphinx/api/cache-get.json @@ -1,7 +1,7 @@ { "avail": "1.4.0", "brief": [ - "Returns full content of the host cache." + "This command returns the full content of the host cache." ], "hook": "host_cache", "name": "cache-get", diff --git a/doc/sphinx/api/cache-insert.json b/doc/sphinx/api/cache-insert.json index c8354e910e..2cf5db5d47 100644 --- a/doc/sphinx/api/cache-insert.json +++ b/doc/sphinx/api/cache-insert.json @@ -1,7 +1,7 @@ { "avail": "1.4.0", "brief": [ - "This command may be used to manually insert a host into the cache." + "This command manually inserts a host into the cache." ], "cmd-syntax": [ "{", diff --git a/doc/sphinx/api/cache-load.json b/doc/sphinx/api/cache-load.json index 823a471f4a..3932dac9fc 100644 --- a/doc/sphinx/api/cache-load.json +++ b/doc/sphinx/api/cache-load.json @@ -1,7 +1,7 @@ { "avail": "1.4.0", "brief": [ - "This command allows load the contents of a file on disk into an in-memory cache." + "This command allows the contents of a file on disk to be loaded into an in-memory cache." ], "cmd-syntax": [ "{", @@ -16,4 +16,4 @@ "kea-dhcp4", "kea-dhcp6" ] -} \ No newline at end of file +} diff --git a/doc/sphinx/api/cache-remove.json b/doc/sphinx/api/cache-remove.json index c3ad0f644a..b824647f05 100644 --- a/doc/sphinx/api/cache-remove.json +++ b/doc/sphinx/api/cache-remove.json @@ -1,7 +1,7 @@ { "avail": "1.4.0", "brief": [ - "The cache-remove command works similarly to reservation-get command." + "This command works similarly to the ``reservation-get`` command." ], "cmd-syntax": [ "{", @@ -12,7 +12,7 @@ " }", "}", "", - "Another example that removes IPv6 host identifier by DUID and specific subnet-id is:", + "Another example that removes the IPv6 host identifier by DUID and specific subnet-id is:", "{", " \"command\": \"cache-remove\",", " \"arguments\": {", @@ -28,4 +28,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 c7e227147c..48681fcd0d 100644 --- a/doc/sphinx/api/cache-size.json +++ b/doc/sphinx/api/cache-size.json @@ -1,7 +1,7 @@ { "avail": "1.6.0", "brief": [ - "Returns the number of entries in the host cache." + "This command returns the number of entries in the host cache." ], "hook": "host_cache", "name": "cache-size", diff --git a/doc/sphinx/api/cache-write.json b/doc/sphinx/api/cache-write.json index baa015f4f8..6c8c15b41b 100644 --- a/doc/sphinx/api/cache-write.json +++ b/doc/sphinx/api/cache-write.json @@ -1,10 +1,10 @@ { "avail": "1.4.0", "brief": [ - "Instructs Kea to write its host cache content to disk." + "This command instructs Kea to write its host cache content to disk." ], "cmd-comment": [ - "The command takes one mandatory argument that specifies a filename path of a file to be written." + "The command takes one mandatory argument that specifies the filename path of a file to be written." ], "cmd-syntax": [ "{", @@ -18,4 +18,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 e4868e27ce..7e7ec01a29 100644 --- a/doc/sphinx/api/class-add.json +++ b/doc/sphinx/api/class-add.json @@ -1,12 +1,10 @@ { "avail": "1.5.0", "brief": [ - "This command is used to create and add a new class to the existing", - "server configuration." + "This command creates and adds a new class to the existing 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": [ "{", @@ -28,8 +26,7 @@ "hook": "class_cmds", "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)." + "The command is successful (result 0), unless the class name is a duplicate or another error occurs (result 1)." ], "resp-syntax": [ "{", diff --git a/doc/sphinx/api/class-del.json b/doc/sphinx/api/class-del.json index 86852122c1..8c073f1b9d 100644 --- a/doc/sphinx/api/class-del.json +++ b/doc/sphinx/api/class-del.json @@ -1,7 +1,7 @@ { "avail": "1.5.0", "brief": [ - "This command is used to remove a client class from the server configuration." + "This command removes a client class from the server configuration." ], "cmd-syntax": [ "{", @@ -15,10 +15,14 @@ "hook": "class_cmds", "name": "class-del", "resp-comment": [ +<<<<<<< HEAD "The command will return a result of 3 (empty) if the client", "class doesn't exist. If the client class exists, the returned", "result is 0 if the deletion was successful and the result is 1", "if the deletion is unsuccessful." +======= + "The command returns a result of 3 (empty) if the client class does not exist. If the client class exists, the returned result is 0 if the deletion was successful; the result is 1 if the deletion is unsuccessful." +>>>>>>> Fix grammar, typos, a few JSON errors ], "resp-syntax": [ "{", diff --git a/doc/sphinx/api/class-get.json b/doc/sphinx/api/class-get.json index 00c9738d93..648bd00134 100644 --- a/doc/sphinx/api/class-get.json +++ b/doc/sphinx/api/class-get.json @@ -1,8 +1,7 @@ { "avail": "1.5.0", "brief": [ - "This command is used to return detailed information about an", - "existing client class." + "This command returns detailed information about an existing client class." ], "cmd-syntax": [ "{", @@ -16,13 +15,7 @@ "hook": "class_cmds", "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." + "The returned information depends on the DHCP server type, i.e. some parameters are specific to the DHCPv4 server. Also, some parameters may not be returned if they are not set for the client class. If a class with the specified name does not 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": [ "{", @@ -35,7 +28,7 @@ " \"only-if-required\": ,", " \"test\": ,", " \"option-data\": [