-----Original Message-----
From: Vishal Verma [mailto:vishal.l.verma@intel.com]
Sent: Wednesday, August 15, 2018 8:06 AM
To: linux-nvdimm(a)lists.01.org
Cc: Vishal Verma <vishal.l.verma(a)intel.com>; Qi, Fuli/斉 福利
<qi.fuli(a)jp.fujitsu.com>
Subject: [ndctl PATCH 1/3] ndctl, monitor: Fix formatting for --log in the man page
Change the --log option to be similar to other options-with-arguments, such as --map.
Cc: QI Fuli <qi.fuli(a)jp.fujitsu.com>
Fixes: 8d2d75f76f1e ("ndctl, monitor: set default log destination to syslog
if...")
Signed-off-by: Vishal Verma <vishal.l.verma(a)intel.com>
---
Documentation/ndctl/ndctl-monitor.txt | 23 ++++++++++-------------
1 file changed, 10 insertions(+), 13 deletions(-)
diff --git a/Documentation/ndctl/ndctl-monitor.txt
b/Documentation/ndctl/ndctl-monitor.txt
index 9a8d76b..363c398 100644
--- a/Documentation/ndctl/ndctl-monitor.txt
+++ b/Documentation/ndctl/ndctl-monitor.txt
@@ -65,20 +65,17 @@ OPTIONS
A 'namespaceX.Y' device name, or namespace region plus id tuple
'X.Y'.
--l <file | syslog | standard>::
---log=<file | syslog | standard>::
+-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.
-syslog::
- Send messages to syslog.
-standard::
- Send messages to standard output.
---
-+
+ - "<file>":
+ Send log messages to specified <file>. When fopen() is not able
+ to open <file>, log messages will be forwarded to syslog.
+ - "syslog":
+ Send messages to syslog.
+ - "standard":
+ Send messages to standard output.
+
Looks good to me.
Please feel free to add: Reviewed-by: QI Fuli <qi.fui(a)jp.fujitsu.com>
Thanks,
QI
The default log destination is 'syslog' if
"--daemon" is specified, otherwise 'standard'.
Note that standard and relative path for <file> will not work if
"--daemon" is specified.
--
2.14.4