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

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]

Date:   Sat, 30 Apr 2022 09:57:19 +0900
From:   Akira Yokosawa <akiyks@...il.com>
To:     Shenghong Han <hanshenghong2019@...il.szu.edu.cn>, corbet@....net
Cc:     akpm@...ux-foundation.org, baihaowen@...zu.com, seakeel@...il.com,
        linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        caoyixuan2019@...il.szu.edu.cn, yejiajian2018@...il.szu.edu.cn,
        yuhongf@....edu.cn
Subject: Re: [PATCH] Documentation/vm/page_owner.rst: Fix syntax error and
 Describe details using table

Hi,

On Sat, 30 Apr 2022 02:19:26 +0800,
Shenghong Han wrote:
> Subject: [PATCH] Documentation/vm/page_owner.rst: ...
This is v2 of the patch, isn't it?  If so, it should be indicated
in the prefix as "[PATCH v2]".

> 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.
In changelog, describe technical facts.  Not what you think or hope.
You need to do a respin with a better explanation at least.

Hint: A fix without using tables would be the simplest.  Please look
at the changes in the preceding section I made in commit 5603f9bdea68
("docs: vm/page_owner: use literal blocks for param description").
You are seeing the build error because a literal block ends at a next
line which starts from column 1.

I don't think Jon would dislike the simplest approach. :-)

Of course, if you guys love tables so much, I don't mind.

> 
> Signed-off-by: Shenghong Han <hanshenghong2019@...il.szu.edu.cn>
> Fixes: edc93abbcc6d ("tools/vm/page_owner_sort.c: support sorting blocks by multiple keys")
SHA-1 ID of a not-yet-merged commit will likely break later in
the merge window.

Good luck!

        Thanks, Akira
> 
> ---
> 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
[...]