linux-kernel - Re: [PATCH 2/2] doc/vm/page_owner.rst: Fix table display confusion

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <3ce4feb9-5477-e7fb-e98c-3d6342ddc7b5@gmail.com>
Date:   Sun, 24 Apr 2022 12:38:10 +0900
From:   Akira Yokosawa <akiyks@...il.com>
To:     baihaowen@...zu.com
Cc:     alexs@...nel.org, corbet@....net, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org, seakeel@...il.com,
        siyanteng01@...il.com, siyanteng@...ngson.cn
Subject: Re: [PATCH 2/2] doc/vm/page_owner.rst: Fix table display confusion

Hi,

Wed, 20 Apr 2022 11:06:56 +0800,
baihaowen wrote:
> After make htmldocs, the table which is made of tab will
> display all by one line. so we make a standard table for STANDARD
> FORMAT SPECIFIERS description.
> 
> Signed-off-by: Haowen Bai <baihaowen@...zu.com>
> ---
>  Documentation/vm/page_owner.rst | 34 ++++++++++++++++++++--------------
>  1 file changed, 20 insertions(+), 14 deletions(-)
> 
> diff --git a/Documentation/vm/page_owner.rst b/Documentation/vm/page_owner.rst
> index 422d5fa99e84..a8505e3a3044 100644
> --- a/Documentation/vm/page_owner.rst
> +++ b/Documentation/vm/page_owner.rst
> @@ -174,22 +174,28 @@ STANDARD FORMAT SPECIFIERS
>  
>  For --sort option:
>  
> -	KEY		LONG		DESCRIPTION
> -	p		pid		process ID
> -	tg		tgid		thread group ID
> -	n		name		task command name
> -	st		stacktrace	stack trace of the page allocation
> -	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
> +        ====            ==========      ============================================
> +        KEY             LONG            DESCRIPTION
> +        ====            ==========      ============================================
> +        p               pid             process ID
> +        tg              tgid            thread group ID
> +        n               name            task command name
> +        st              stacktrace      stack trace of the page allocation
> +        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
> +        ====            ==========      ============================================
>  
>  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
> +        ====            ===========     ============================================
> +        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
> +        ====            ===========     ============================================

This patch looks like against akpm's tree (or linux-next).
So it is not applicable to docs-next of Jonathan's tree at the
moment.

You need to wait until docs-next catches up akpm's tree.

Patch 1/2 should wait until the English doc is updated,
I suppose.

By the way, I don't think the list of options need tables.
Literal blocks should suffice.

I mean, How about the simpler changes:

>  For --sort option:
   For --sort option::

>  For --curl option:
   For --curl option::

Thoughts?

       Thanks, Akira

> -- 
> 2.7.4