[ndctl] ndctl/namespace: Fixup man page indentation
diff mbox series

Message ID 157237178859.4146560.1913830646961375457.stgit@dwillia2-desk3.amr.corp.intel.com
State Accepted
Commit 6b916db066be97d0538eccfa6806b9aad1979542
Headers show
Series
  • [ndctl] ndctl/namespace: Fixup man page indentation
Related show

Commit Message

Dan Williams Oct. 29, 2019, 5:56 p.m. UTC
Text that follows a list tends to continue the list indentation. Use a
bare "::" to end the list indentation.

Signed-off-by: Dan Williams <dan.j.williams@intel.com>
---
 Documentation/ndctl/ndctl-create-namespace.txt |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Verma, Vishal L Oct. 29, 2019, 8:18 p.m. UTC | #1
On Tue, 2019-10-29 at 10:56 -0700, Dan Williams wrote:
> Text that follows a list tends to continue the list indentation. Use a
> bare "::" to end the list indentation.
> 
> Signed-off-by: Dan Williams <dan.j.williams@intel.com>
> ---
>  Documentation/ndctl/ndctl-create-namespace.txt |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/ndctl/ndctl-create-namespace.txt b/Documentation/ndctl/ndctl-create-namespace.txt
> index 45a4c4c2f408..8cd80fa789c1 100644
> --- a/Documentation/ndctl/ndctl-create-namespace.txt
> +++ b/Documentation/ndctl/ndctl-create-namespace.txt
> @@ -155,7 +155,7 @@ OPTIONS
>  	per-page metadata.  The allocation can be drawn from either:
>  	- "mem": typical system memory
>  	- "dev": persistent memory reserved from the namespace
> -
> +::
>  	Given relative capacities of "Persistent Memory" to "System
>  	RAM" the allocation defaults to reserving space out of the
>  	namespace directly ("--map=dev"). The overhead is 64-bytes per
> 
Good find!

I see how this (ab)uses the list marker by creating a new list item
without a new 'term' associated with it. I disliked creating a new list
item when the paragraph logically belongs in the previous list, and I
tried to use various combinations of list continuation markers, play
around with list starts/ends, but couldn't get the paragraph to
dissociate from the 'dev/mem' sublist and associate it back to the
'parent' list.

So I'll take this :)

Patch
diff mbox series

diff --git a/Documentation/ndctl/ndctl-create-namespace.txt b/Documentation/ndctl/ndctl-create-namespace.txt
index 45a4c4c2f408..8cd80fa789c1 100644
--- a/Documentation/ndctl/ndctl-create-namespace.txt
+++ b/Documentation/ndctl/ndctl-create-namespace.txt
@@ -155,7 +155,7 @@  OPTIONS
 	per-page metadata.  The allocation can be drawn from either:
 	- "mem": typical system memory
 	- "dev": persistent memory reserved from the namespace
-
+::
 	Given relative capacities of "Persistent Memory" to "System
 	RAM" the allocation defaults to reserving space out of the
 	namespace directly ("--map=dev"). The overhead is 64-bytes per