]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#719] Updated doc & co
authorFrancis Dupont <fdupont@isc.org>
Mon, 13 Mar 2023 00:13:23 +0000 (01:13 +0100)
committerFrancis Dupont <fdupont@isc.org>
Wed, 15 Mar 2023 12:49:21 +0000 (13:49 +0100)
doc/examples/kea4/all-keys-netconf.json
doc/examples/kea4/all-keys.json
doc/examples/kea6/all-keys-netconf.json
doc/examples/kea6/all-keys.json
doc/sphinx/arm/dhcp4-srv.rst
doc/sphinx/arm/dhcp6-srv.rst
src/bin/dhcp4/dhcp4_parser.yy

index 8aa6366904b61d916735394b1a29426c32409d17..cc33a6650ae81d88cf80b77425fb268c95c18e80 100644 (file)
         "option-data": [
             {
                 // Boolean flag indicating if the given option is always
-                // send in response or only when requested. The default
+                // sent in response or only when requested. The default
                 // value of false indicates that it is only sent when
                 // requested.
                 "always-send": false,
                 "name": "domain-name-servers",
 
                 // Boolean flag indicating if the given option is never
-                // send in response. The default value of false indicates
+                // sent in response. The default value of false indicates
                 // that it is sent when it should. When true the option
                 // is not sent despite of any other setting, i.e. it is
                 // a final flag.
                                 "name": "routers",
 
                                 // Boolean flag indicating if the given option is never
-                                // send in response.
+                                // sent in response.
                                 "never-send": false,
 
                                 // Option space. The default value "dhcp4" designates the
index ccf01dde1f48fffa5b59ba88fdca5e42c886771a..401feb6ee8c246a5725a02fb63df5052eaa1d3f5 100644 (file)
         "option-data": [
             {
                 // Boolean flag indicating if the given option is always
-                // send in response or only when requested. The default
+                // sent in response or only when requested. The default
                 // value of false indicates that it is only sent when
                 // requested.
                 "always-send": false,
                 "name": "domain-name-servers",
 
                 // Boolean flag indicating if the given option is never
-                // send in response. The default value of false indicates
+                // sent in response. The default value of false indicates
                 // that it is sent when it should. When true the option
                 // is not sent despite of any other setting, i.e. it is
                 // a final flag.
                                 "name": "routers",
 
                                 // Boolean flag indicating if the given option is never
-                                // send in response.
+                                // sent in response.
                                 "never-send": false,
 
                                 // Option space. The default value "dhcp4" designates the
index 990adf4a6df786ff57cfcc6b556e03edb5640690..148b6ec99e04d8339f1db62aa50d6e2049c4f884 100644 (file)
         "option-data": [
             {
                 // Boolean flag indicating if the given option is always
-                // send in response or only when requested. The default
+                // sent in response or only when requested. The default
                 // value of false indicates that it is only sent when
                 // requested.
                 "always-send": false,
                 "name": "dns-servers",
 
                 // Boolean flag indicating if the given option is never
-                // send in response. The default value of false indicates
+                // sent in response. The default value of false indicates
                 // that it is sent when it should. When true the option
                 // is not sent despite of any other setting, i.e. it is
                 // a final flag.
                                 "name": "preference",
 
                                 // Boolean flag indicating if the given option is never
-                                // send in response.
+                                // sent in response.
                                 "never-send": false,
 
                                 // Option space. The default value "dhcp6" designates the
index 81e113c309e2d51a40bf9f5fec380b343b099288..74c7a60f8cd129897556c9b93a43b84d9a22a360 100644 (file)
         "option-data": [
             {
                 // Boolean flag indicating if the given option is always
-                // send in response or only when requested. The default
+                // sent in response or only when requested. The default
                 // value of false indicates that it is only sent when
                 // requested.
                 "always-send": false,
                 "name": "dns-servers",
 
                 // Boolean flag indicating if the given option is never
-                // send in response. The default value of false indicates
+                // sent in response. The default value of false indicates
                 // that it is sent when it should. When true the option
                 // is not sent despite of any other setting, i.e. it is
                 // a final flag.
                                 "name": "preference",
 
                                 // Boolean flag indicating if the given option is never
-                                // send in response.
+                                // sent in response.
                                 "never-send": false,
 
                                 // Option space. The default value "dhcp6" designates the
index 149988a2980ea9853d96502ccf400ab6ec258025..c308fe0eec23334a1a5677d1353b330ef7e13531 100644 (file)
@@ -1486,14 +1486,15 @@ Parameter Request List option (or its equivalent for vendor options):
    }
 
 
-The ``domain-name-servers`` option is always added to responses (the
-always-send is "sticky"), but the value is the subnet one when the client
-is localized in the subnet.
+In the example above, the ``domain-name-servers`` option respects the global 
+``always-send`` flag and is always added to responses, but for subnet 
+``192.0.3.0/24``, the value is taken from the subnet-level option data 
+specification.
 
 At the opposite of ``always-send`` if the ``never-send`` flag is set to
 ``true`` for a particular option the server does not add it to the response.
 The effect is the same as if the client removed the option code in the
-Parameter Request List option Option (or its equivalent for vendor options):
+Parameter Request List option (or its equivalent for vendor options):
 
 ::
 
@@ -1522,9 +1523,9 @@ Parameter Request List option Option (or its equivalent for vendor options):
        ...
    }
 
-The ``domain-name-servers`` option is never added to responses (the
-never-send is "sticky" too). The ``never-send`` is as the precedence
-over ``always-send`` so if both are true the option is not added.
+In the example above, ``domain-name-servers`` option is never added to
+responses on subnet ``192.0.3.0/24``. ``never-send`` has precedence over
+``always-send`` so if both are true the option is not added.
 
 .. note::
 
index 594d6c4aaf48ec860dd201157c454f724f6489c2..a9ec10132b2b2654d661f162b27793b1af0a4994 100644 (file)
@@ -1413,9 +1413,10 @@ Option Request Option (or its equivalent for vendor options), as in:
    }
 
 
-The ``dns-servers`` option is always added to responses (the always-send is
-"sticky"), but the value is the subnet one when the client is localized
-in the subnet.
+In the example above, the ``dns-servers`` option respects the global
+``always-send`` flag and is always added to responses, but for subnet
+``2001:db8:1::/64``, the value is taken from the subnet-level option data
+specification.
 
 At the opposite of ``always-send`` if the ``never-send`` flag is set to
 ``true`` for a particular option the server does not add it to the response.
@@ -1449,9 +1450,9 @@ Option Request Option (or its equivalent for vendor options), as in:
        ...
    }
 
-The ``dns-server`` option is never added to responses (the never-send is
-"sticky" too). The ``never-send`` is as the precedence over ``always-send``
-so if both are true the option is not added.
+In the example above, the ``dns-server`` option is never added to responses
+on subnet ``2001:db8:1::/64``. ``never-send`` has precedence over
+``always-send`` so if both are true the option is not added.
 
 .. note::
 
index 98c8d3c4cbee0566c2303e16e32567b3a275334e..e39c35ed6f7bb34bb4b5a7ef58867c8d2188e0b5 100644 (file)
@@ -1996,8 +1996,8 @@ option_data_space: space;
 
 option_data_csv_format: CSV_FORMAT COLON BOOLEAN {
     ctx.unique("csv-format", ctx.loc2pos(@1));
-    ElementPtr space(new BoolElement($3, ctx.loc2pos(@3)));
-    ctx.stack_.back()->set("csv-format", space);
+    ElementPtr csv(new BoolElement($3, ctx.loc2pos(@3)));
+    ctx.stack_.back()->set("csv-format", csv);
 };
 
 option_data_always_send: ALWAYS_SEND COLON BOOLEAN {
@@ -2008,8 +2008,8 @@ option_data_always_send: ALWAYS_SEND COLON BOOLEAN {
 
 option_data_never_send: NEVER_SEND COLON BOOLEAN {
     ctx.unique("never-send", ctx.loc2pos(@1));
-    ElementPtr persist(new BoolElement($3, ctx.loc2pos(@3)));
-    ctx.stack_.back()->set("never-send", persist);
+    ElementPtr cancel(new BoolElement($3, ctx.loc2pos(@3)));
+    ctx.stack_.back()->set("never-send", cancel);
 };
 
 // ---- pools ------------------------------------