Add documentation of new log-timestamp and log-color options.
Signed-off-by: Stephen Hemminger <step...@networkplumber.org>
---
doc/guides/linux_gsg/eal_args.include.rst | 54 +++++++++++++++++++----
1 file changed, 46 insertions(+), 8 deletions(-)
diff --git a/doc/guides/linux_gsg/eal_args.include.rst
b/doc/guides/linux_gsg/eal_args.include.rst
index 9cfbf7de8456..8ba54a62c0f9 100644
--- a/doc/guides/linux_gsg/eal_args.include.rst
+++ b/doc/guides/linux_gsg/eal_args.include.rst
@@ -122,6 +122,52 @@ Memory-related options
to system pthread stack size unless the optional size (in kbytes) is
specified.
+Logging options
+~~~~~~~~~~~~~~~
+
+* ``--log-level <type:val>``
+
+ Specify log level for a specific component. For example::
+
+ --log-level lib.eal:debug
+
+ Can be specified multiple times.
+
+* ``--log-facility=facility``
+
+ Specifies the ``syslog`` facility passed to ``openlog``.
+ The facility can be: ``auth``, ``cron``, ``daemon``, ``ftp``,
+ ``lpr``, ``mail``, ``news``, ``user``, ``uucp``,
+ ``local0``, ``local1``, ``local2``, ``local3``, ``local4``,
+ ``local5``, ``local6``, or ``local7``. The default if
+ no facility is specified is ``daemon``.
+
+* ``--log-timestamp[=format]``
+
+ Add a time stamp to log messages that are sent to the console (stderr).
+ When format argument is omitted the time stamp is elapsed
+ seconds since the start of the DPDK application.
+ Other formats are:
+
+.. csv-table:: Log time stamp format
+ :header: "Format", "Description", "Example"
+ :widths: 6, 30, 32
+
+ "ctime", "Unix ctime", "``[Wed Mar 20 07:26:12 2024]``"
+ "delta", "Offset since last", "``[< 3.162373>]``"
+ "reltime", "Seconds since last or time if minute changed", "``[
+3.001791]`` or ``[Mar20 07:26:12]``"
+ "iso", "ISO-8601", "``[2024-03-20T07:26:12−07:00]``"
+
+* ``--log-color[=when]``
+
+ Colorize the console output.
+ The optional argument ``when`` can be ``auto``, ``never`` or ``always``.
+ If the when argument is omitted, it defaults to ``auto``.
+ To disable use of color::
+
+ --log-color=none
+
+
Debugging options
~~~~~~~~~~~~~~~~~
@@ -134,14 +180,6 @@ Debugging options
Use anonymous memory instead of hugepages (implies no secondary process
support).
-* ``--log-level <type:val>``
-
- Specify log level for a specific component. For example::
-
- --log-level lib.eal:debug
-
- Can be specified multiple times.
-
* ``--trace=<regex-match>``
Enable trace based on regular expression trace name. By default, the trace
is
--
2.43.0
