From: Dan Theisen <djt@isc.org>
Date: Thu, 17 Mar 2022 14:32:31 +0000 (-0700)
Subject: [#2265] Update description of subnetX-update in ARM to clarify behavior
X-Git-Tag: Kea-2.1.4~26
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=beb1e17c2a8b218e8f8070feb7f818bbfb603b4a;p=thirdparty%2Fkea.git

[#2265] Update description of subnetX-update in ARM to clarify behavior
---

diff --git a/doc/sphinx/arm/hooks.rst b/doc/sphinx/arm/hooks.rst
index 70a3649611..d3ed074532 100644
--- a/doc/sphinx/arm/hooks.rst
+++ b/doc/sphinx/arm/hooks.rst
@@ -2600,8 +2600,8 @@ The following commands are currently supported:
 -  ``subnet4-add/subnet6-add`` - adds a new subnet into the server's
    configuration.
 
--  ``subnet4-update/subnet6-update`` - updates a subnet in the server's
-   configuration.
+-  ``subnet4-update/subnet6-update`` - updates (replaces) a single subnet in
+   the server's configuration.
 
 -  ``subnet4-del/subnet6-del`` - removes a subnet from the server's
    configuration.
@@ -2933,9 +2933,9 @@ automatic ``subnet-id`` generation works in Kea.
 The ``subnet4-update`` Command
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-This command is used to update a subnet in the existing server
-configuration. This operation has no impact on other subnets. The subnet
-identifier is used to identify the subnet to replace; it must be
+This command is used to update (overwrite) a single subnet in the existing
+server configuration. This operation has no impact on other subnets. The
+subnet identifier is used to identify the subnet to replace; it must be
 specified and must be unique among all subnets. The subnet prefix should
 not be updated.
 
@@ -2980,9 +2980,9 @@ The response to this command has the following structure:
 The ``subnet6-update`` Command
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-This command is used to update a subnet in the existing server
-configuration. This operation has no impact on other subnets. The subnet
-identifier is used to identify the subnet to replace; it must be
+This command is used to update (overwrite) a single subnet in the existing
+server configuration. This operation has no impact on other subnets. The
+subnet identifier is used to identify the subnet to replace; it must be
 specified and must be unique among all subnets. The subnet prefix should
 not be updated.
 
diff --git a/src/share/api/subnet4-update.json b/src/share/api/subnet4-update.json
index b0f44712bc..cb084f400b 100644
--- a/src/share/api/subnet4-update.json
+++ b/src/share/api/subnet4-update.json
@@ -2,7 +2,7 @@
     "access": "write",
     "avail": "1.6.0",
     "brief": [
-        "This command updates a subnet in the existing server configuration. This operation has no impact on other subnets."
+        "This command updates (overwrites) a single subnet in the existing server configuration. This operation has no impact on other subnets."
     ],
     "cmd-syntax": [
         "{",
diff --git a/src/share/api/subnet6-update.json b/src/share/api/subnet6-update.json
index 1509a79de0..e6dfd6912c 100644
--- a/src/share/api/subnet6-update.json
+++ b/src/share/api/subnet6-update.json
@@ -2,7 +2,7 @@
     "access": "write",
     "avail": "1.6.0",
     "brief": [
-        "This command updates a subnet in the existing server configuration. This operation has no impact on other subnets."
+        "This command updates (overwrites) a single subnet in the existing server configuration. This operation has no impact on other subnets."
     ],
     "cmd-syntax": [
         "{",