diff --git a/doc/sphinx/arm/dhcp4-srv.rst b/doc/sphinx/arm/dhcp4-srv.rst index 293f82d411..2eda450b16 100644 --- 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 f3217b50be..fda0015757 100644 --- 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 d2079dcae8..a0f8f8b1ed 100644 --- 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 7dc900cfa1..dae5be7a2c 100644 --- 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 880d44b876..e7d35ce472 100644 --- 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 4f02ab069b..28467f4d7d 100644 --- 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 738bb44162..a6a2870261 100644 --- 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 cebeec69f6..2c7cae502f 100644 --- 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 0594706aa2..e10ac8f58f 100644 --- 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