2023-03-25 02:55:09

by Sergey Senozhatsky

[permalink] [raw]
Subject: [PATCH 0/2] zsmalloc: minor documentation updates

Hi,

Two minor patches that bring zsmalloc documentation up to date.

Sergey Senozhatsky (2):
zsmalloc: document new fullness grouping
zsmalloc: document freeable stats

Documentation/mm/zsmalloc.rst | 135 +++++++++++++++++++---------------
1 file changed, 76 insertions(+), 59 deletions(-)

--
2.40.0.348.gf938b09366-goog


2023-03-25 02:55:57

by Sergey Senozhatsky

[permalink] [raw]
Subject: [PATCH 2/2] zsmalloc: document freeable stats

When freeable class stat was added to classes file (back in 2016)
we forgot to update zsmalloc documentation. Fix that.

Signed-off-by: Sergey Senozhatsky <[email protected]>
---
Documentation/mm/zsmalloc.rst | 2 ++
1 file changed, 2 insertions(+)

diff --git a/Documentation/mm/zsmalloc.rst b/Documentation/mm/zsmalloc.rst
index 3c6bf639887f..a3c26d587752 100644
--- a/Documentation/mm/zsmalloc.rst
+++ b/Documentation/mm/zsmalloc.rst
@@ -83,6 +83,8 @@ pages_used
the number of pages allocated for the class
pages_per_zspage
the number of 0-order pages to make a zspage
+freeable
+ the approximate number of pages class compaction can free

Each zspage maintains inuse counter which keeps track of the number of
objects stored in the zspage. The inuse counter determines the zspage's
--
2.40.0.348.gf938b09366-goog

2023-03-25 20:09:42

by Andrew Morton

[permalink] [raw]
Subject: Re: [PATCH 0/2] zsmalloc: minor documentation updates

On Sat, 25 Mar 2023 11:46:29 +0900 Sergey Senozhatsky <[email protected]> wrote:

> Two minor patches that bring zsmalloc documentation up to date.
>

It would be best to keep the in-kernel documentation accurate
for the kernel version with which it is shipped. So can you
please suggest a Fixes: for these two?

2023-03-26 01:21:56

by Sergey Senozhatsky

[permalink] [raw]
Subject: Re: [PATCH 0/2] zsmalloc: minor documentation updates

On (23/03/25 12:54), Andrew Morton wrote:
> On Sat, 25 Mar 2023 11:46:29 +0900 Sergey Senozhatsky <[email protected]> wrote:
>
> > Two minor patches that bring zsmalloc documentation up to date.
> >
>
> It would be best to keep the in-kernel documentation accurate
> for the kernel version with which it is shipped. So can you
> please suggest a Fixes: for these two?

Sure.

For zsmalloc-document-new-fullness-grouping.patch it's not very trivial,
since the patch covers several internal zsmalloc changes: new fullness
grouping and new zsmalloc classes stats fullness format. I think it's OK
to just say that it fixes patch that converted zsmalloc classes stats to
new format.