Re: [PATCH] Documentation/vm/page_owner.rst: Fix syntax error and Describe details using table

[Akira Yokosawa]

On 2022/04/30 3:19,
Shenghong Han wrote:
> Some syntax errors exist in "page_owner.rst". Thanks to Akira Yokosawa and
> Haowen Bai for tips to help improve the documentation.
> 
> We try to fix them. Hope that the Documentation is showed as we expect.
> 
> Signed-off-by: Shenghong Han <hanshenghong2019@xxxxxxxxxxxxxxxx>
> Fixes: edc93abbcc6d ("tools/vm/page_owner_sort.c: support sorting blocks by multiple keys")
> 
> ---
> Thanks Jonathan's suggestion.
> 
> This fix is a simpler than before.
> And yes, It has built in my machine.
> 
> Best,
> 
> 	Shenghong Han
> ---
> ---
>  Documentation/vm/page_owner.rst | 15 ++++++++++-----
>  1 file changed, 10 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/vm/page_owner.rst b/Documentation/vm/page_owner.rst
> index 25622c715..0ecb4a739 100644
> --- a/Documentation/vm/page_owner.rst
> +++ b/Documentation/vm/page_owner.rst
> @@ -171,11 +171,12 @@ Usage
>  
>  STANDARD FORMAT SPECIFIERS
>  ==========================
> -::
>  
> -For --sort option:
> +1) For --sort option.
>  
> +	====		==========	===========
>  	KEY		LONG		DESCRIPTION
> +	====		==========	===========
>  	p		pid		process ID
>  	tg		tgid		thread group ID
>  	n		name		task command name
> @@ -183,14 +184,18 @@ For --sort option:
>  	T		txt		full text of block
>  	ft		free_ts		timestamp of the page when it was released
>  	at		alloc_ts	timestamp of the page when it was allocated
> -        ator            allocator       memory allocator for pages
> +	ator		allocator	memory allocator for pages
> +	====		==========	===========
>  
> -For --curl option:
> +2) For --curl option.
>  
> +	====		==========	===========
>  	KEY		LONG		DESCRIPTION
> +	====		==========	===========
>  	p		pid		process ID
>  	tg		tgid		thread group ID
>  	n		name		task command name
>  	f		free		whether the page has been released or not
>  	st		stacktrace	stack trace of the page allocation
> -        ator            allocator       memory allocator for pages
> +	ator		allocator	memory allocator for pages
> +	====		==========	===========

So, I have actually tested this.

Are you OK with the look of

  1) For --sort option.

and

  2) For --curl option.

in generated HTML or PDF docs?

In literal blocks, you would see double dashes of "--".
Now they are converted to so-called endash, which is a single dash
slightly longer than a normal hyphen.  It looks confusing to me.

To remedy this, you need inline literal markers of

  1) For ``--sort`` option.

and

  2) For ``--curl`` option.


By the way, this patch changes ":" to "." at the end of them.
Are they intentional changes?  If so, why?

        Thanks, Akira