]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#3011] address review comments
authordankney <dankney@isc.org>
Wed, 6 Sep 2023 19:09:50 +0000 (15:09 -0400)
committerDarren Ankney <dankney@isc.org>
Thu, 14 Sep 2023 17:11:00 +0000 (17:11 +0000)
doc/sphinx/arm/logging.rst

index 60bb80c03c4636ab9223b36946fb4399dada5949..0c3c5c763ee2055c9c4337b583bc5ad8b44c89db 100644 (file)
@@ -880,7 +880,7 @@ A complete list of logging parameters supported by Kea is shown in the table bel
    +-----------+------------------------------------------------------------------------+
    | ``%m``    | Outputs the actual log message                                         |
    +-----------+------------------------------------------------------------------------+
-   | ``%M``    | Outputs caller of the log message                                      |
+   | ``%M``    | Outputs caller (function name) of the log message                      |
    +-----------+------------------------------------------------------------------------+
    | ``%n``    | Outputs line separator suppored by platform e.g., ``\n`` in Linux      |
    +-----------+------------------------------------------------------------------------+
@@ -888,7 +888,7 @@ A complete list of logging parameters supported by Kea is shown in the table bel
    +-----------+------------------------------------------------------------------------+
    | ``%r``    | Outputs milliseconds since program start e.g., 1235                    |
    +-----------+------------------------------------------------------------------------+
-   | ``%t``    | Outputs thread id that generated the log message e.g, 281472855306256  |
+   | ``%t``    | Outputs thread id that generated the log message e.g., 281472855306256 |
    +-----------+------------------------------------------------------------------------+
    | ``%T``    | Outputs thread name that generated the log message e.g., 168005        |
    +-----------+------------------------------------------------------------------------+
@@ -905,7 +905,7 @@ sign. There are five ways of modifying the output shown by example here.
     Left pads with spaces (align right) if the severity is shorter than 20 characters.
 
   - ``%-15r``
-    Right pads with spaces (align left) if the milliseconds since program start is less
+    Right pads with spaces (align left) if the milliseconds since program start is shorter
     than 15 characters.
 
   - ``%.30m``
@@ -921,6 +921,12 @@ sign. There are five ways of modifying the output shown by example here.
     Right pad with spaces (align left) if the log message is shorter than 15 characters.
     If the message is longer than 40 characters, truncate from the beginning.
 
+Supported parameters depend on the liblog4cplus version used to compile Kea.  This can
+be checked by executing ``kea-dhcp4 -W | grep -i log4cplus`` which will produce output
+like this: ``LOG4CPLUS_VERSION:  2.0.5``.  Consult the documentation in the 
+`log4cplus wiki <https://github.com/log4cplus/log4cplus/wiki>`__ for further information
+about the version you have installed.
+
 Example Logger Configurations
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~