Re: [PATCH v4 10/10] cxl: add man page documentation for monitor

["Verma, Vishal L" <vishal.l.verma@intel.com>]

On Tue, 2022-11-08 at 11:30 -0700, Dave Jiang wrote:
> Add man page documentation to explain the usage of cxl monitor.
> 
> Signed-off-by: Dave Jiang <dave.jiang@intel.com>
> ---
>  Documentation/cxl/cxl-monitor.txt |   77 +++++++++++++++++++++++++++++++++++++

Is this missing an update to a meson.build in Documentation/cxl?

>  1 file changed, 77 insertions(+)
>  create mode 100644 Documentation/cxl/cxl-monitor.txt
> 
> diff --git a/Documentation/cxl/cxl-monitor.txt b/Documentation/cxl/cxl-monitor.txt
> new file mode 100644
> index 000000000000..43c2ece72220
> --- /dev/null
> +++ b/Documentation/cxl/cxl-monitor.txt
> @@ -0,0 +1,77 @@
> +// SPDX-License-Identifier: GPL-2.0
> +
> +cxl-monitor(1)
> +================

Unaligned '===' line

> +
> +NAME
> +----
> +cxl-monitor - Monitor the CXL kernel trace events

Probably drop 'kernel' here.

> +
> +SYNOPSIS
> +--------
> +[verse]
> +'cxl monitor' [<options>]
> +
> +DESCRIPTION
> +-----------
> +Cxl monitor is used for monitoring the CXL trace events emitted by

s/Cxl/CXL/ or s/Cxl monitor/cxl-monitor/ I think.

> +the kernel and convert them to json objects and dumping the json format
> +notifications to standard output or a logfile.
> +
> +Both, the values in configuration file and in options will work. If

s/file/file,/

Also is config file support actually present yet?

> +there is a conflict, the values in options will override the values in
> +the configuration file. Any updated values in the configuration file will
> +take effect only after the monitor process is restarted.
> +
> +EXAMPLES
> +--------
> +
> +Run a monitor as a daemon to monitor events and output to a log file.
> +[verse]
> +cxl monitor --daemon --log=/var/log/cxl-monitor.log
> +
> +Run a monitor as a one-shot command and output the notifications to stdio.
> +[verse]
> +cxl monitor
> +
> +Run a monitor daemon as a system service
> +[verse]
> +systemctl start cxl-monitor.service
> +
> +OPTIONS
> +-------
> +-l::
> +--log=::
> +       Send log messages to the specified destination.
> +       - "<file>":
> +         Send log messages to specified <file>. When fopen() is not able
> +         to open <file>, log messages will be forwarded to syslog.
> +       - "standard":
> +         Send messages to standard output.
> +
> +The default log destination is '/var/log/cxl-monitor.log' if "--daemon" is specified,
> +otherwise 'standard'. Note that standard and relative path for <file>
> +will not work if "--daemon" is specified.
> +
> +--daemon::
> +       Run a monitor as a daemon.
> +
> +-u::
> +--human::
> +       Output monitor notification as human friendly json format instead
> +       of the default machine friendly json format.
> +
> +-v::
> +--verbose::
> +       Emit extra debug messages to log.
> +
> +COPYRIGHT
> +---------
> +Copyright (c) 2022, Intel Corp. License GPLv2: GNU GPL version 2
> +<http://gnu.org/licenses/gpl.html>. This is free software: you are
> +free to change and redistribute it. There is NO WARRANTY, to the
> +extent permitted by law.

I think there is an include for the copyright under Documentation/cxl,
as well as for human and verbose options.

> +
> +SEE ALSO
> +--------
> +linkcxl:cxl-list[1]
> 
>