[PATCH] Documentation/vm/page_owner.rst: fix the description of "-f"

[PATCH] Documentation/vm/page_owner.rst: fix the description of "-f"

[Yixuan Cao]

Few days ago,
I noticed that in tools/vm/page_owner_sort.c,
there is a comment that need to be fixed.

In function usage():
"-f Filter out the information of blocks whose memory has
not been released."

This comment does not match the actual function, the "not"
should be removed. As a result, I submitted a patch to fix it.

Similarly, this document should also do the same
modification, that's why I submit this patch.

Signed-off-by: Yixuan Cao <caoyixuan2019@email.szu.edu.cn>
---
 Documentation/vm/page_owner.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/vm/page_owner.rst b/Documentation/vm/page_owner.rst
index aec1906976f4..32ca54757d3f 100644
--- a/Documentation/vm/page_owner.rst
+++ b/Documentation/vm/page_owner.rst
@@ -78,7 +78,7 @@ Usage
 
 2) Enable page owner: add "page_owner=on" to boot cmdline.
 
-3) Do the job what you want to debug
+3) Do the job what you want to debug.
 
 4) Analyze information from page owner::
 
@@ -126,4 +126,4 @@ Usage
 		-c		Cull by comparing stacktrace instead of total block.
 
 	Filter:
-		-f		Filter out the information of blocks whose memory has not been released.
+		-f		Filter out the information of blocks whose memory has been released.
-- 
2.31.1

Re: [PATCH] Documentation/vm/page_owner.rst: fix the description of "-f"

[Shuah Khan]

On 2/25/22 2:08 AM, Yixuan Cao wrote:
> Few days ago,
> I noticed that in tools/vm/page_owner_sort.c,
> there is a comment that need to be fixed.
> 
> In function usage():
> "-f Filter out the information of blocks whose memory has
> not been released."
> 
> This comment does not match the actual function, the "not"
> should be removed. As a result, I submitted a patch to fix it.
> 
> Similarly, this document should also do the same
> modification, that's why I submit this patch.
> 

Please refer to a few change logs to write them so maintainers
don't have to fix them. This can be written as:

"Fix function usage information for -f option"

> Signed-off-by: Yixuan Cao <caoyixuan2019@email.szu.edu.cn>
> ---
>   Documentation/vm/page_owner.rst | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/vm/page_owner.rst b/Documentation/vm/page_owner.rst
> index aec1906976f4..32ca54757d3f 100644
> --- a/Documentation/vm/page_owner.rst
> +++ b/Documentation/vm/page_owner.rst
> @@ -78,7 +78,7 @@ Usage
>   
>   2) Enable page owner: add "page_owner=on" to boot cmdline.
>   
> -3) Do the job what you want to debug
> +3) Do the job what you want to debug.
>   
>   4) Analyze information from page owner::
>   
> @@ -126,4 +126,4 @@ Usage
>   		-c		Cull by comparing stacktrace instead of total block.
>   
>   	Filter:
> -		-f		Filter out the information of blocks whose memory has not been released.
> +		-f		Filter out the information of blocks whose memory has been released.
> 

I can't find this in Linux 5.17-rc5 - is this patch based on linux-next?

thanks,
-- Shuah