[#2904] adding alias output-options in ARM docs

diff --git a/doc/sphinx/arm/dhcp4-srv.rst b/doc/sphinx/arm/dhcp4-srv.rst
index 293f82d41157085cccb4161cdb6b492c29726f23..2eda450b163ae3df1eec2db9024ffbc63dd07d5c 100644 (file)
--- a/doc/sphinx/arm/dhcp4-srv.rst
+++ b/doc/sphinx/arm/dhcp4-srv.rst
@@ -4272,7 +4272,7 @@ ISC tested the following configuration:
        "loggers": [
        {
            "name": "kea-dhcp4",
-           "output_options": [
+           "output-options": [
            {
                "output": "/tmp/kea-dhcp4.log"
            }

diff --git a/doc/sphinx/arm/dhcp6-srv.rst b/doc/sphinx/arm/dhcp6-srv.rst
index f3217b50bedb8db262914fa90cff2e187e5d8f28..fda001575717a115f113b2597f77258a31f2ae06 100644 (file)
--- a/doc/sphinx/arm/dhcp6-srv.rst
+++ b/doc/sphinx/arm/dhcp6-srv.rst
@@ -3624,7 +3624,7 @@ ISC tested the following configuration:
 
        "loggers": [ {
            "name": "kea-dhcp6",
-           "output_options": [ {
+           "output-options": [ {
                "output": "/tmp/kea-dhcp6.log"
            } ],
            "severity": "DEBUG",

diff --git a/doc/sphinx/arm/ext-netconf.rst b/doc/sphinx/arm/ext-netconf.rst
index d2079dcae85a3e1e5649f6fc554b411e05fb7b46..a0f8f8b1ed6ae897be2015850db9b968c96dd42c 100644 (file)
--- a/doc/sphinx/arm/ext-netconf.rst
+++ b/doc/sphinx/arm/ext-netconf.rst
@@ -631,7 +631,7 @@ Kea sources.
            "loggers": [
                {
                    "name": "kea-netconf",
-                   "output_options": [
+                   "output-options": [
                        {
                            "output": "/var/log/kea-netconf.log",
                            // Several additional parameters are possible in
@@ -779,7 +779,7 @@ The following is the example ``netconf.json`` configuration for
           {
             "debuglevel": 99,
             "name": "kea-netconf",
-            "output_options": [
+            "output-options": [
               {
                 "output": "stderr"
               }
@@ -1102,7 +1102,7 @@ The corresponding Kea configuration in JSON is:
        "loggers": [
          {
            "name": "kea-dhcp6",
-           "output_options": [
+           "output-options": [
              {
                "output": "stderr"
              }

diff --git a/doc/sphinx/arm/logging.rst b/doc/sphinx/arm/logging.rst
index 7dc900cfa1b01b5bfab0a3c1849102302e26b7a1..dae5be7a2c8346b21551d01f51fccc17682dd2c0 100644 (file)
--- a/doc/sphinx/arm/logging.rst
+++ b/doc/sphinx/arm/logging.rst
@@ -608,12 +608,21 @@ level of debug messages to be printed. It ranges from 0 (least
 verbose) to 99 (most verbose). If severity for the logger is not DEBUG,
 this value is ignored.
 
-The ``output_options`` (list) Logger
+The ``output-options`` (list) Logger
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Each logger can have zero or more ``output_options``. These specify
+Each logger can have zero or more ``output-options``. These specify
 where log messages are sent and are explained in detail below.
 
+.. note::
+
+   As of Kea 2.5.1, alias ``output-options`` was added to replace
+   previous ``output_options`` configuration key. The reason behind this
+   was to keep all configuration keys consistent i.e. 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. In future, older
+   ``output_options`` configuration key will be deprecated.
+
 The ``output`` (string) Option
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -939,7 +948,7 @@ console using standard output.
        "loggers": [
            {
                "name": "kea-dhcp4",
-               "output_options": [
+               "output-options": [
                    {
                        "output": "stdout"
                    }
@@ -959,7 +968,7 @@ logfile grows to 2MB, it should be renamed and a new file should be created.
        "loggers": [
            {
                "name": "kea-dhcp6",
-               "output_options": [
+               "output-options": [
                    {
                        "output": "/var/log/kea-debug.log",
                        "maxver": 8,

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