[#3004] addressed comments

diff --git a/ChangeLog b/ChangeLog
index 90f326d80ccb3fedd23a02e3d3d4226ef698e248..94bc954c13a0fa91cd10de8bc60d09171198f6c7 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,8 +1,8 @@
-2176.  [doc]           piotrek
-       Updated ARM docs with new configuration key alias
-       "output-options". All config examples, where previous
+2176.  [doc]           piotrek, razvan
+       Updated ARM docs with new configuration key "output-options" and
+       alias "output_options". All config examples, where previous
        "output_options" key appeared, were updated.
-       (Gitlab #2904)
+       (Gitlab #2904, #3004)
 
 Kea 2.5.1 (development) released on August 30, 2023
 

diff --git a/doc/sphinx/arm/logging.rst b/doc/sphinx/arm/logging.rst
index 9e2b6beea529bd14520cad4cefa5b4f50424246f..56e99d04bcb8a3e31cbfaa93bd76da6b7a067c1a 100644 (file)
--- a/doc/sphinx/arm/logging.rst
+++ b/doc/sphinx/arm/logging.rst
@@ -622,6 +622,9 @@ where log messages are sent and are explained in detail below.
    to use "dash" instead of "underscore" in the key name. For the time being
    both configuration keys are considered correct and mean the same to Kea parsers.
 
+   As of Kea 2.5.2, the ``output-options`` becomes the default configuration key
+   and ``output_options`` can be used as an alias.
+
 The ``output`` (string) Option
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

diff --git a/doc/sphinx/grammar/grammar-ca-parser.rst b/doc/sphinx/grammar/grammar-ca-parser.rst
index 880d44b876936ae0d51572269231c8149f85d3b1..e7d35ce47249675f968bfcec403e0fb6bb3e3c06 100644 (file)
--- a/doc/sphinx/grammar/grammar-ca-parser.rst
+++ b/doc/sphinx/grammar/grammar-ca-parser.rst
@@ -223,7 +223,7 @@ This grammar is generated from ``agent_parser.yy``. See :ref:`kea-ctrl-agent` fo
 
      severity ::= "severity" ":" STRING
 
-     output_options_list ::= "output_options" ":" "[" output_options_list_content "]"
+     output_options_list ::= "output-options" ":" "[" output_options_list_content "]"
 
      output_options_list_content ::= output_entry
                                 | output_options_list_content "," output_entry

diff --git a/doc/sphinx/grammar/grammar-d2-parser.rst b/doc/sphinx/grammar/grammar-d2-parser.rst
index 4f02ab069be6aa569d59ab437d92e1a4e668c03f..28467f4d7d1efd49489471db036ba3925bcb3697 100644 (file)
--- a/doc/sphinx/grammar/grammar-d2-parser.rst
+++ b/doc/sphinx/grammar/grammar-d2-parser.rst
@@ -280,7 +280,7 @@ This grammar is generated from ``d2_parser.yy``. See :ref:`dhcp-ddns-server` for
 
      severity ::= "severity" ":" STRING
 
-     output_options_list ::= "output_options" ":" "[" output_options_list_content "]"
+     output_options_list ::= "output-options" ":" "[" output_options_list_content "]"
 
      output_options_list_content ::= output_entry
                                 | output_options_list_content "," output_entry

diff --git a/doc/sphinx/grammar/grammar-dhcp4-parser.rst b/doc/sphinx/grammar/grammar-dhcp4-parser.rst
index 738bb44162b330b891c6337524b2ede1e7f1d964..a6a28702612fa60be3f65da66f4b4c10c3e7a29d 100644 (file)
--- a/doc/sphinx/grammar/grammar-dhcp4-parser.rst
+++ b/doc/sphinx/grammar/grammar-dhcp4-parser.rst
@@ -1003,7 +1003,7 @@ This grammar is generated from ``dhcp4_parser.yy``. See :ref:`dhcp4` for more de
 
      severity ::= "severity" ":" STRING
 
-     output_options_list ::= "output_options" ":" "[" output_options_list_content "]"
+     output_options_list ::= "output-options" ":" "[" output_options_list_content "]"
 
      output_options_list_content ::= output_entry
                                 | output_options_list_content "," output_entry

diff --git a/doc/sphinx/grammar/grammar-dhcp6-parser.rst b/doc/sphinx/grammar/grammar-dhcp6-parser.rst
index cebeec69f662d0798ca6b852c6f7f2841b5ffa29..2c7cae502fe4a004ebc8eda8c3812aafe9c8662d 100644 (file)
--- a/doc/sphinx/grammar/grammar-dhcp6-parser.rst
+++ b/doc/sphinx/grammar/grammar-dhcp6-parser.rst
@@ -1054,7 +1054,7 @@ This grammar is generated from ``dhcp6_parser.yy``. See :ref:`dhcp6` for more de
 
      severity ::= "severity" ":" STRING
 
-     output_options_list ::= "output_options" ":" "[" output_options_list_content "]"
+     output_options_list ::= "output-options" ":" "[" output_options_list_content "]"
 
      output_options_list_content ::= output_entry
                                 | output_options_list_content "," output_entry

diff --git a/doc/sphinx/grammar/grammar-netconf-parser.rst b/doc/sphinx/grammar/grammar-netconf-parser.rst
index 0594706aa2ed2b48f6f42fb1ece6b4f1235fe22a..e10ac8f58f700e01a178cc41e6e8394e046b72d6 100644 (file)
--- a/doc/sphinx/grammar/grammar-netconf-parser.rst
+++ b/doc/sphinx/grammar/grammar-netconf-parser.rst
@@ -191,7 +191,7 @@ This grammar is generated from ``netconf_parser.yy``. See :ref:`netconf` for mor
 
      severity ::= "severity" ":" STRING
 
-     output_options_list ::= "output_options" ":" "[" output_options_list_content "]"
+     output_options_list ::= "output-options" ":" "[" output_options_list_content "]"
 
      output_options_list_content ::= output_entry
                                 | output_options_list_content "," output_entry