* [PATCH] Documentation: zram: remove sections numbering
@ 2026-07-28 2:12 Sergey Senozhatsky
2026-07-29 1:31 ` SJ Park
0 siblings, 1 reply; 2+ messages in thread
From: Sergey Senozhatsky @ 2026-07-28 2:12 UTC (permalink / raw)
To: Andrew Morton
Cc: Minchan Kim, Jonathan Corbet, linux-kernel, linux-doc,
Sergey Senozhatsky, Sebastian Andrzej Siewior
Those numbers are difficult to maintain and in fact
we can refer to sections by their names (in html).
Suggested-by: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
Signed-off-by: Sergey Senozhatsky <senozhatsky@chromium.org>
---
Documentation/admin-guide/blockdev/zram.rst | 40 ++++++++++-----------
1 file changed, 20 insertions(+), 20 deletions(-)
diff --git a/Documentation/admin-guide/blockdev/zram.rst b/Documentation/admin-guide/blockdev/zram.rst
index 60b07a7e30cd..2f6bbfd991fe 100644
--- a/Documentation/admin-guide/blockdev/zram.rst
+++ b/Documentation/admin-guide/blockdev/zram.rst
@@ -61,8 +61,8 @@ and, in general case, something like::
should suffice.
-1) Load Module
-==============
+Load Module
+===========
::
@@ -73,8 +73,8 @@ This creates 4 devices: /dev/zram{0,1,2,3}
num_devices parameter is optional and tells zram how many devices should be
pre-created. Default: 1.
-2) Select compression algorithm
-===============================
+Select compression algorithm
+============================
Using comp_algorithm device attribute one can see available and
currently selected (shown in square brackets) compression algorithms,
@@ -93,8 +93,8 @@ Examples::
For the time being, the `comp_algorithm` content shows only compression
algorithms that are supported by zram.
-3) Set compression algorithm parameters: Optional
-=================================================
+Set compression algorithm parameters: Optional
+==============================================
Compression algorithms may support specific parameters which can be
tweaked for particular dataset. ZRAM has an `algorithm_params` device
@@ -124,8 +124,8 @@ better the compression ratio, it even can take negatives values for some
algorithms), for other algorithms `level` is acceleration level (the higher
the value the lower the compression ratio).
-4) Set Disksize
-===============
+Set Disksize
+============
Set disk size by writing the value to sysfs node 'disksize'.
The value can be either in bytes or you can use mem suffixes.
@@ -144,8 +144,8 @@ There is little point creating a zram of greater than twice the size of memory
since we expect a 2:1 compression ratio. Note that zram uses about 0.1% of the
size of the disk when not in use so a huge zram is wasteful.
-5) Set memory limit: Optional
-=============================
+Set memory limit: Optional
+==========================
Set memory limit by writing the value to sysfs node 'mem_limit'.
The value can be either in bytes or you can use mem suffixes.
@@ -163,8 +163,8 @@ Examples::
# To disable memory limit
echo 0 > /sys/block/zram0/mem_limit
-6) Activate
-===========
+Activate
+========
::
@@ -174,8 +174,8 @@ Examples::
mkfs.ext4 /dev/zram1
mount /dev/zram1 /tmp
-7) Add/remove zram devices
-==========================
+Add/remove zram devices
+=======================
zram provides a control interface, which enables dynamic (on-demand) device
addition and removal.
@@ -194,8 +194,8 @@ execute::
echo X > /sys/class/zram-control/hot_remove
-8) Stats
-========
+Stats
+=====
Per-device statistics are exported as various nodes under /sys/block/zram<id>/
@@ -296,16 +296,16 @@ a single line of text and contains the following stats separated by whitespace:
Unit: 4K bytes
============== =============================================================
-9) Deactivate
-==============
+Deactivate
+==========
::
swapoff /dev/zram0
umount /dev/zram1
-10) Reset
-=========
+Reset
+=====
Write any positive value to 'reset' sysfs node::
--
2.55.0.229.g6434b31f56-goog
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] Documentation: zram: remove sections numbering
2026-07-28 2:12 [PATCH] Documentation: zram: remove sections numbering Sergey Senozhatsky
@ 2026-07-29 1:31 ` SJ Park
0 siblings, 0 replies; 2+ messages in thread
From: SJ Park @ 2026-07-29 1:31 UTC (permalink / raw)
To: Sergey Senozhatsky
Cc: SJ Park, Andrew Morton, Minchan Kim, Jonathan Corbet,
linux-kernel, linux-doc, Sebastian Andrzej Siewior
On Tue, 28 Jul 2026 11:12:11 +0900 Sergey Senozhatsky <senozhatsky@chromium.org> wrote:
> Those numbers are difficult to maintain and in fact
> we can refer to sections by their names (in html).
>
> Suggested-by: Sebastian Andrzej Siewior <bigeasy@linutronix.de>
> Signed-off-by: Sergey Senozhatsky <senozhatsky@chromium.org>
Reviewed-by: SJ Park <sj@kernel.org>
Thanks,
SJ
[...]
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2026-07-29 1:31 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-07-28 2:12 [PATCH] Documentation: zram: remove sections numbering Sergey Senozhatsky
2026-07-29 1:31 ` SJ Park
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.