diff --git a/AUTHORS b/AUTHORS index 0f59b9f56c2df0122ddb1b7de1d2b5c9023060b3..4e8812ed5e0a62d8caa4339e9e03bfe46d66b295 100644 --- a/AUTHORS +++ b/AUTHORS @@ -22,6 +22,7 @@ Primary developers: - Shawn Routhier (lease file cleanup) - Michal Nowikowski (testing, hammer, release engineering) - Razvan Becheriu (cassandra, sysrepo) + - Suzanne Goldlust (documentation) Primary area of work mentioned in parentheses. The list is in a roughly chronological order. diff --git a/ChangeLog b/ChangeLog index 370d67735e89eab8681703a9f395ccbc01d911c1..0ee43e56c5275507883a0c14ac210620a0e093f2 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +1649. [doc] sgoldlust + API documentation updated and cleaned up. + (Gitlab #810,!471, git f1ae84186beb54d45f8455236827108289b0b0d6) + 1648. [func] fdupont,marcin Client classification information (client-class, require-client-classes) and excluded prefix (excluded-prefix, diff --git a/doc/sphinx/api/build-report.json b/doc/sphinx/api/build-report.json index fb3d25f45724ca3c1dd23ffc7d7eef0addd8d061..97d900b0028dac2e6d54bc29b0314a2a91fee29e 100644 --- a/doc/sphinx/api/build-report.json +++ b/doc/sphinx/api/build-report.json @@ -1,7 +1,7 @@ { "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": [ "{", @@ -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 10a24a990a71612d6e22ad9a42467a0721f73f27..ef6bf34c80c0e5a980f9ea73f1899e6d465a2c53 100644 --- a/doc/sphinx/api/cache-get-by-id.json +++ b/doc/sphinx/api/cache-get-by-id.json @@ -1,21 +1,22 @@ { "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": [ "{", " \"command\": \"cache-get-by-id\",", " \"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\": ", "}" ], @@ -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 3c27a1121831671c47c51b2b013c3a46d92315e0..b7af01d0f29dbe7b61231e3a1ade020f7c4f225c 100644 --- a/doc/sphinx/api/cache-get.json +++ b/doc/sphinx/api/cache-get.json @@ -1,14 +1,14 @@ { "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", "resp-syntax": [ "{", - " \"result\": 0", - " \"text\": \"123 entries returned.\"", + " \"result\": 0,", + " \"text\": \"123 entries returned.\",", " \"arguments\": ", "}" ], @@ -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 64c9bc6565d607711c337307c6237550d7e9cf8e..cdcfe6a25fa6b85eccd82e2d30fccd101c6691fe 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 inserts a host into the cache." ], "cmd-syntax": [ "{", @@ -49,4 +49,4 @@ "kea-dhcp4", "kea-dhcp6" ] -} \ No newline at end of file +} diff --git a/doc/sphinx/api/cache-load.json b/doc/sphinx/api/cache-load.json index 823a471f4a52865d9fc3c608a7bab698a3751793..3932dac9fc9c21b1e9ca8ec95de991f6882569e9 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 c3ad0f644a1ce8cc075077d14c595e37e9a3a6c2..697b94f59a248edabc9a72738ad445d8bffed115 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 removes entries from the host cache. It takes parameters similar 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 b5340733d47848dc64df3e676b4b88cd1e41290a..48681fcd0d617222b0c18c889ef463f692dcabc1 100644 --- a/doc/sphinx/api/cache-size.json +++ b/doc/sphinx/api/cache-size.json @@ -1,14 +1,14 @@ { "avail": "1.6.0", "brief": [ - "Returns number of entries of the host cache." + "This command returns the number of entries in the host cache." ], "hook": "host_cache", "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/cache-write.json b/doc/sphinx/api/cache-write.json index baa015f4f8eca927687d70fb369faf7457ba558c..6c8c15b41b7582d4d96b4705ca6b7d81668a6a2c 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 611f1a490cb6b7fa04df5e681c7d63caa530ca44..1760ebd1dd751ac14c1abb9085e291e2d914a72d 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 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": [ "{", @@ -16,7 +14,7 @@ " \"name\": ,", " \"test\": ,", " \"option-data\": [