[ndctl PATCH 1/3] ndctl, monitor: Fix formatting for --log in the man page

nvdimm.lists.linux.dev archive mirror
 help / color / mirror / Atom feed

* [ndctl PATCH 1/3] ndctl, monitor: Fix formatting for --log in the man page
@ 2018-08-14 23:05 Vishal Verma
  2018-08-14 23:05 ` [ndctl PATCH 2/3] ndctl, list: fix the verbosity level formatting " Vishal Verma
                   ` (2 more replies)
  0 siblings, 3 replies; 5+ messages in thread
From: Vishal Verma @ 2018-08-14 23:05 UTC (permalink / raw)
  To: linux-nvdimm

Change the --log option to be similar to other options-with-arguments,
such as --map.

Cc: QI Fuli <qi.fuli@jp.fujitsu.com>
Fixes: 8d2d75f76f1e ("ndctl, monitor: set default log destination to syslog if...")
Signed-off-by: Vishal Verma <vishal.l.verma@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.
+
 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

_______________________________________________
Linux-nvdimm mailing list
Linux-nvdimm@lists.01.org
https://lists.01.org/mailman/listinfo/linux-nvdimm

^ permalink raw reply related	[flat|nested] 5+ messages in thread

* [ndctl PATCH 2/3] ndctl, list: fix the verbosity level formatting in the man page
  2018-08-14 23:05 [ndctl PATCH 1/3] ndctl, monitor: Fix formatting for --log in the man page Vishal Verma
@ 2018-08-14 23:05 ` Vishal Verma
  2018-08-14 23:05 ` [ndctl PATCH 3/3] ndctl, docs: Use asciidoctor by default Vishal Verma
  2018-08-15  0:30 ` [ndctl PATCH 1/3] ndctl, monitor: Fix formatting for --log in the man page Qi, Fuli
  2 siblings, 0 replies; 5+ messages in thread
From: Vishal Verma @ 2018-08-14 23:05 UTC (permalink / raw)
  To: linux-nvdimm

The docbook->markdown rendering for the list verbosity options ate up
the newlines. Fix by forcing it into a bulleted list.

Cc: Keith Busch <keith.busch@intel.com>
Fixes: b2c9a47f474f ("ndctl: Add 'list' verbose options")
Signed-off-by: Vishal Verma <vishal.l.verma@intel.com>
---
 Documentation/ndctl/ndctl-list.txt | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/Documentation/ndctl/ndctl-list.txt b/Documentation/ndctl/ndctl-list.txt
index c823493..e24c8f4 100644
--- a/Documentation/ndctl/ndctl-list.txt
+++ b/Documentation/ndctl/ndctl-list.txt
@@ -207,13 +207,14 @@ include::xable-region-options.txt[]
 	multiple times to be even more verbose on the informational and
 	miscellaneous output, and can be used to override omitted flags
 	for showing specific information. +
-*-v*
-In addition to the enabled namespaces default output, show the numa_node,
-raw_uuid, and bad block media errors. +
-*-vv*
-Everything '-v' provides, plus automatically enable --dimms, --buses, and --regions. +
-*-vvv*
-Everything '-vv' provides, plus --health, --idle, and --firmware.
+	- *-v*
+	  In addition to the enabled namespaces default output, show the
+	  numa_node, raw_uuid, and bad block media errors. +
+	- *-vv*
+	  Everything '-v' provides, plus automatically enable --dimms,
+	  --buses, and --regions. +
+	- *-vvv*
+	  Everything '-vv' provides, plus --health, --idle, and --firmware.
 
 include::human-option.txt[]
 
-- 
2.14.4

_______________________________________________
Linux-nvdimm mailing list
Linux-nvdimm@lists.01.org
https://lists.01.org/mailman/listinfo/linux-nvdimm

^ permalink raw reply related	[flat|nested] 5+ messages in thread

* [ndctl PATCH 3/3] ndctl, docs: Use asciidoctor by default
  2018-08-14 23:05 [ndctl PATCH 1/3] ndctl, monitor: Fix formatting for --log in the man page Vishal Verma
  2018-08-14 23:05 ` [ndctl PATCH 2/3] ndctl, list: fix the verbosity level formatting " Vishal Verma
@ 2018-08-14 23:05 ` Vishal Verma
  2018-08-15 17:32   ` [ndctl PATCH v2] " Vishal Verma
  2018-08-15  0:30 ` [ndctl PATCH 1/3] ndctl, monitor: Fix formatting for --log in the man page Qi, Fuli
  2 siblings, 1 reply; 5+ messages in thread
From: Vishal Verma @ 2018-08-14 23:05 UTC (permalink / raw)
  To: linux-nvdimm

The asciidoc built documentation has several formatting artifacts (e.g.
Using asciidoctor for the build fixes this, so switch to it as the
default. This can still be disabled during configure using
"--disable-asciidoctor"

Signed-off-by: Vishal Verma <vishal.l.verma@intel.com>
---
 configure.ac | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/configure.ac b/configure.ac
index 00178bb..7bfe5a7 100644
--- a/configure.ac
+++ b/configure.ac
@@ -45,7 +45,7 @@ AM_CONDITIONAL([ENABLE_DOCS], [test "x$enable_docs" = "xyes"])
 AC_ARG_ENABLE([asciidoctor],
 	AS_HELP_STRING([--enable-asciidoctor],
 	[use asciidoctor for documentation build]),
-	[], enable_asciidoctor=no)
+	[], enable_asciidoctor=yes)
 AM_CONDITIONAL([USE_ASCIIDOCTOR], [test "x$enable_asciidoctor" = "xyes"])
 if test "x$enable_asciidoctor" = "xyes"; then
 	asciidoc="asciidoctor"
-- 
2.14.4

_______________________________________________
Linux-nvdimm mailing list
Linux-nvdimm@lists.01.org
https://lists.01.org/mailman/listinfo/linux-nvdimm

^ permalink raw reply related	[flat|nested] 5+ messages in thread

* [ndctl PATCH v2] ndctl, docs: Use asciidoctor by default
  2018-08-14 23:05 ` [ndctl PATCH 3/3] ndctl, docs: Use asciidoctor by default Vishal Verma
@ 2018-08-15 17:32   ` Vishal Verma
  0 siblings, 0 replies; 5+ messages in thread
From: Vishal Verma @ 2018-08-15 17:32 UTC (permalink / raw)
  To: linux-nvdimm

The asciidoc built documentation has several formatting artifacts (e.g.
Using asciidoctor for the build fixes this, so switch to it as the
default. This can still be disabled during configure using
"--disable-asciidoctor"

Signed-off-by: Vishal Verma <vishal.l.verma@intel.com>
---
 configure.ac  | 2 +-
 ndctl.spec.in | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

v2: update the build dependency in the spec file

diff --git a/configure.ac b/configure.ac
index 00178bb..7bfe5a7 100644
--- a/configure.ac
+++ b/configure.ac
@@ -45,7 +45,7 @@ AM_CONDITIONAL([ENABLE_DOCS], [test "x$enable_docs" = "xyes"])
 AC_ARG_ENABLE([asciidoctor],
 	AS_HELP_STRING([--enable-asciidoctor],
 	[use asciidoctor for documentation build]),
-	[], enable_asciidoctor=no)
+	[], enable_asciidoctor=yes)
 AM_CONDITIONAL([USE_ASCIIDOCTOR], [test "x$enable_asciidoctor" = "xyes"])
 if test "x$enable_asciidoctor" = "xyes"; then
 	asciidoc="asciidoctor"
diff --git a/ndctl.spec.in b/ndctl.spec.in
index 062aafb..b782aea 100644
--- a/ndctl.spec.in
+++ b/ndctl.spec.in
@@ -10,7 +10,7 @@ Source0:	https://github.com/pmem/%{name}/archive/v%{version}.tar.gz#/%{name}-%{v
 Requires:	LNAME%{?_isa} = %{version}-%{release}
 Requires:	DAX_LNAME%{?_isa} = %{version}-%{release}
 BuildRequires:	autoconf
-BuildRequires:	asciidoc
+BuildRequires:	rubygem-asciidoctor
 BuildRequires:	xmlto
 BuildRequires:	automake
 BuildRequires:	libtool
-- 
2.14.4

_______________________________________________
Linux-nvdimm mailing list
Linux-nvdimm@lists.01.org
https://lists.01.org/mailman/listinfo/linux-nvdimm

^ permalink raw reply related	[flat|nested] 5+ messages in thread

* RE: [ndctl PATCH 1/3] ndctl, monitor: Fix formatting for --log in the man page
  2018-08-14 23:05 [ndctl PATCH 1/3] ndctl, monitor: Fix formatting for --log in the man page Vishal Verma
  2018-08-14 23:05 ` [ndctl PATCH 2/3] ndctl, list: fix the verbosity level formatting " Vishal Verma
  2018-08-14 23:05 ` [ndctl PATCH 3/3] ndctl, docs: Use asciidoctor by default Vishal Verma
@ 2018-08-15  0:30 ` Qi, Fuli
  2 siblings, 0 replies; 5+ messages in thread
From: Qi, Fuli @ 2018-08-15  0:30 UTC (permalink / raw)
  To: 'Vishal Verma', linux-nvdimm

> -----Original Message-----
> From: Vishal Verma [mailto:vishal.l.verma@intel.com]
> Sent: Wednesday, August 15, 2018 8:06 AM
> To: linux-nvdimm@lists.01.org
> Cc: Vishal Verma <vishal.l.verma@intel.com>; Qi, Fuli/斉 福利
> <qi.fuli@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@jp.fujitsu.com>
> Fixes: 8d2d75f76f1e ("ndctl, monitor: set default log destination to syslog if...")
> Signed-off-by: Vishal Verma <vishal.l.verma@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@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
> 
> 


_______________________________________________
Linux-nvdimm mailing list
Linux-nvdimm@lists.01.org
https://lists.01.org/mailman/listinfo/linux-nvdimm

^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2018-08-15 17:32 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-08-14 23:05 [ndctl PATCH 1/3] ndctl, monitor: Fix formatting for --log in the man page Vishal Verma
2018-08-14 23:05 ` [ndctl PATCH 2/3] ndctl, list: fix the verbosity level formatting " Vishal Verma
2018-08-14 23:05 ` [ndctl PATCH 3/3] ndctl, docs: Use asciidoctor by default Vishal Verma
2018-08-15 17:32   ` [ndctl PATCH v2] " Vishal Verma
2018-08-15  0:30 ` [ndctl PATCH 1/3] ndctl, monitor: Fix formatting for --log in the man page Qi, Fuli

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).