From: Tomek Mrugalski Date: Wed, 14 Aug 2019 20:53:50 +0000 (+0200) Subject: [#826,!479] Reworded the API description slightly. X-Git-Tag: Kea-1.6.0~41^2~82 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9b469ab63a9627e377a219cf8f83033e4e613b11;p=thirdparty%2Fkea.git [#826,!479] Reworded the API description slightly. --- diff --git a/doc/sphinx/api/remote-option4-network-del.json b/doc/sphinx/api/remote-option4-network-del.json index 0304e26add..839b5ae1ca 100644 --- a/doc/sphinx/api/remote-option4-network-del.json +++ b/doc/sphinx/api/remote-option4-network-del.json @@ -1,7 +1,7 @@ { "avail": "1.6.0", "brief": [ - "This command deletes a DHCPv4 shared network option from the configuration database." + "This command deletes a DHCPv4 option from a shared network from the configuration database." ], "cmd-comment": [ "This command includes two lists with exactly one name of the shared network and exactly one option specification, comprising an option name and code. Specifying an empty list, a value of ``null``, or a server tag will result in an error." diff --git a/doc/sphinx/api/remote-option4-network-set.json b/doc/sphinx/api/remote-option4-network-set.json index de238aa99e..6012c046ff 100644 --- a/doc/sphinx/api/remote-option4-network-set.json +++ b/doc/sphinx/api/remote-option4-network-set.json @@ -1,7 +1,7 @@ { "avail": "1.6.0", "brief": [ - "This command creates or replaces a DHCPv4 shared network option in the configuration database." + "This command creates or replaces a DHCPv4 option in a shared network in the configuration database." ], "cmd-comment": [ "The provided lists must contain exactly one name of the shared network and one option specification. Specifying an empty list, a value of ``null``, or a server tag will result in an error." diff --git a/doc/sphinx/api/remote-option4-pool-del.json b/doc/sphinx/api/remote-option4-pool-del.json index 0ec63c2e02..b4b9459195 100644 --- a/doc/sphinx/api/remote-option4-pool-del.json +++ b/doc/sphinx/api/remote-option4-pool-del.json @@ -1,7 +1,7 @@ { "avail": "1.6.0", "brief": [ - "This command deletes a DHCPv4 address pool option from the configuration database." + "This command deletes a DHCPv4 option from an address pool from the configuration database." ], "cmd-comment": [ "This command includes two lists with exactly one address pool specification and exactly one option specification comprising an option space name and code. Specifying an empty list, a value of ``null``, or a server tag will result in an error." diff --git a/doc/sphinx/api/remote-option4-pool-set.json b/doc/sphinx/api/remote-option4-pool-set.json index 0167c9dd34..609f314d10 100644 --- a/doc/sphinx/api/remote-option4-pool-set.json +++ b/doc/sphinx/api/remote-option4-pool-set.json @@ -1,7 +1,7 @@ { "avail": "1.6.0", "brief": [ - "This command creates or replaces a DHCPv4 address pool option in the configuration database." + "This command creates or replaces a DHCPv4 option in an address pool in the configuration database." ], "cmd-comment": [ "This command includes two lists with exactly address pool specification and exactly one option specification. Specifying an empty list, a value of ``null``, or a server tag will result in an error." diff --git a/doc/sphinx/api/remote-option4-subnet-del.json b/doc/sphinx/api/remote-option4-subnet-del.json index 15991a56a9..c1dbea549d 100644 --- a/doc/sphinx/api/remote-option4-subnet-del.json +++ b/doc/sphinx/api/remote-option4-subnet-del.json @@ -1,7 +1,7 @@ { "avail": "1.6.0", "brief": [ - "This command deletes a DHCPv4 subnet option from the configuration database." + "This command deletes a DHCPv4 option from a subnet from the configuration database." ], "cmd-comment": [ "This command includes two lists with exactly one ID of the subnet and exactly one option specification, comprising an option name and code. Specifying an empty list, a value of ``null``, or a server tag will result in an error." diff --git a/doc/sphinx/api/remote-option4-subnet-set.json b/doc/sphinx/api/remote-option4-subnet-set.json index 7eebe93e7a..f57525172f 100644 --- a/doc/sphinx/api/remote-option4-subnet-set.json +++ b/doc/sphinx/api/remote-option4-subnet-set.json @@ -1,7 +1,7 @@ { "avail": "1.6.0", "brief": [ - "This command creates or replaces a DHCPv4 subnet option in the configuration database." + "This command creates or replaces a DHCPv4 option in a subnet in the configuration database." ], "cmd-comment": [ "The provided lists must contain exactly one ID of the subnet and one option specification. Specifying an empty list, a value of ``null``, or a server tag will result in an error." diff --git a/doc/sphinx/api/remote-option6-network-del.json b/doc/sphinx/api/remote-option6-network-del.json index c0b6a19c6c..8ff9ae367b 100644 --- a/doc/sphinx/api/remote-option6-network-del.json +++ b/doc/sphinx/api/remote-option6-network-del.json @@ -1,7 +1,7 @@ { "avail": "1.6.0", "brief": [ - "This command deletes a DHCPv6 shared network option from the configuration database." + "This command deletes a DHCPv6 option from a shared network from the configuration database." ], "cmd-comment": [ "This command includes two lists with exactly one name of the shared network and exactly one option specification, comprising an option name and code. Specifying an empty list, a value of ``null``, or a server tag will result in an error." diff --git a/doc/sphinx/api/remote-option6-network-set.json b/doc/sphinx/api/remote-option6-network-set.json index 09f5b73b51..0648d3dcf8 100644 --- a/doc/sphinx/api/remote-option6-network-set.json +++ b/doc/sphinx/api/remote-option6-network-set.json @@ -1,7 +1,7 @@ { "avail": "1.6.0", "brief": [ - "This command creates or replaces a DHCPv6 shared network option in the configuration database." + "This command creates or replaces a DHCPv6 option in a shared network in the configuration database." ], "cmd-comment": [ "The provided lists must contain exactly one name of the shared network and one option specification. Specifying an empty list, a value of ``null``, or a server tag will result in an error." diff --git a/doc/sphinx/api/remote-option6-pd-pool-del.json b/doc/sphinx/api/remote-option6-pd-pool-del.json index fa230d4c31..6ed764fbb3 100644 --- a/doc/sphinx/api/remote-option6-pd-pool-del.json +++ b/doc/sphinx/api/remote-option6-pd-pool-del.json @@ -1,7 +1,7 @@ { "avail": "1.6.0", "brief": [ - "This command deletes a DHCPv6 prefix delegation pool option from the configuration database." + "This command deletes a DHCPv6 option from a prefix delegation pool from the configuration database." ], "cmd-comment": [ "This command includes two lists with exactly one prefix delegation pool specification and exactly one option specification, comprising an option name and code. Specifying an empty list, a value of ``null``, or a server tag will result in an error." diff --git a/doc/sphinx/api/remote-option6-pd-pool-set.json b/doc/sphinx/api/remote-option6-pd-pool-set.json index f67f95a14d..69b22d77b6 100644 --- a/doc/sphinx/api/remote-option6-pd-pool-set.json +++ b/doc/sphinx/api/remote-option6-pd-pool-set.json @@ -1,7 +1,7 @@ { "avail": "1.6.0", "brief": [ - "This command creates or replaces a DHCPv6 prefix delegation pool option in the configuration database." + "This command creates or replaces a DHCPv6 option in a prefix delegation pool in the configuration database." ], "cmd-comment": [ "This command includes two lists with exactly one prefix delegation pool specification and exactly one option specification. Specifying an empty list, a value of ``null``, or a server tag will result in an error." diff --git a/doc/sphinx/api/remote-option6-pool-del.json b/doc/sphinx/api/remote-option6-pool-del.json index b63efb4473..3694f0e7b4 100644 --- a/doc/sphinx/api/remote-option6-pool-del.json +++ b/doc/sphinx/api/remote-option6-pool-del.json @@ -1,7 +1,7 @@ { "avail": "1.6.0", "brief": [ - "This command deletes a DHCPv6 address pool option from the configuration database." + "This command deletes a DHCPv6 option from an address pool from the configuration database." ], "cmd-comment": [ "This command includes two lists with exactly one address pool specification and exactly one option specification, comprising an option name and code. Specifying an empty list, a value of ``null``, or a server tag will result in an error." diff --git a/doc/sphinx/api/remote-option6-pool-set.json b/doc/sphinx/api/remote-option6-pool-set.json index 09cb0c395f..7c481d2ae7 100644 --- a/doc/sphinx/api/remote-option6-pool-set.json +++ b/doc/sphinx/api/remote-option6-pool-set.json @@ -1,7 +1,7 @@ { "avail": "1.6.0", "brief": [ - "This command creates or replaces a DHCPv6 address pool option in the configuration database." + "This command creates or replaces a DHCPv6 option in an address pool in the configuration database." ], "cmd-comment": [ "This command includes two lists with exactly address pool specification and exactly one option specification. Specifying an empty list, a value of ``null``, or a server tag will result in an error." diff --git a/doc/sphinx/api/remote-option6-subnet-del.json b/doc/sphinx/api/remote-option6-subnet-del.json index 9ae2cdb65d..9b53e7357b 100644 --- a/doc/sphinx/api/remote-option6-subnet-del.json +++ b/doc/sphinx/api/remote-option6-subnet-del.json @@ -1,7 +1,7 @@ { "avail": "1.6.0", "brief": [ - "This command deletes a DHCPv6 subnet option from the configuration database." + "This command deletes a DHCPv6 option from a subnet from the configuration database." ], "cmd-comment": [ "This command includes two lists with exactly one ID of the subnet and exactly one option specification, comprising an option name and code. Specifying an empty list, a value of ``null``, or a server tag will result in an error." diff --git a/doc/sphinx/api/remote-option6-subnet-set.json b/doc/sphinx/api/remote-option6-subnet-set.json index 146d66d77b..c2ade7037b 100644 --- a/doc/sphinx/api/remote-option6-subnet-set.json +++ b/doc/sphinx/api/remote-option6-subnet-set.json @@ -1,7 +1,7 @@ { "avail": "1.6.0", "brief": [ - "This command creates or replaces a DHCPv6 subnet option in the configuration database." + "This command creates or replaces a DHCPv6 option in a subnet in the configuration database." ], "cmd-comment": [ "The provided lists must contain exactly one ID of the subnet and one option specification. Specifying an empty list, a value of ``null``, or a server tag will result in an error."