All of lore.kernel.org
 help / color / mirror / Atom feed
From: Rhajune Park <june@pythonplayer123.dev>
To: dm-devel@lists.linux.dev
Cc: Matthew Sakai <msakai@redhat.com>,
	Rhajune Park <june@pythonplayer123.dev>
Subject: [PATCH 2/2] Documentation: device-mapper: document VDO zstd
Date: Fri, 24 Jul 2026 01:13:50 +0900	[thread overview]
Message-ID: <20260723161350.1080473-2-june@pythonplayer123.dev> (raw)
In-Reply-To: <20260723161350.1080473-1-june@pythonplayer123.dev>

document zstd compression with dm-vdo

Assisted-by: opencode:gpt-5.6-sol
Signed-off-by: Rhajune Park <june@pythonplayer123.dev>
---
 .../admin-guide/device-mapper/vdo.rst         | 21 ++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git a/Documentation/admin-guide/device-mapper/vdo.rst b/Documentation/admin-guide/device-mapper/vdo.rst
index 8a67b320a97b..24a6b26bb990 100644
--- a/Documentation/admin-guide/device-mapper/vdo.rst
+++ b/Documentation/admin-guide/device-mapper/vdo.rst
@@ -171,6 +171,20 @@ Miscellaneous parameters:
 		Whether compression is enabled. The default is 'off'; the
 		acceptable values are 'on' and 'off'.
 
+	compressionAlgorithm:
+		The algorithm used to compress data. The acceptable values are
+		'lz4' and 'zstd'; the default for a new volume is 'lz4'. The
+		algorithm is recorded when the volume is formatted and cannot be
+		changed afterward. If specified when loading an existing volume,
+		it must match the recorded algorithm.
+
+	compressionLevel:
+		The Zstd compression level. The default is 1; negative levels are
+		accepted when supported by the kernel Zstd implementation. This
+		option is invalid with LZ4. The level may be changed after fully
+		deactivating the volume, but not by reloading an active VDO table.
+		It does not affect the readability of data written at another level.
+
 Device modification
 -------------------
 
@@ -178,6 +192,8 @@ A modified table may be loaded into a running, non-suspended vdo volume.
 The modifications will take effect when the device is next resumed. The
 modifiable parameters are <logical device size>, <physical device size>,
 <maxDiscard>, <compression>, and <deduplication>.
+The <compressionAlgorithm> parameter is a format-time property and is not
+modifiable.
 
 If the logical device size or physical device size are changed, upon
 successful resume vdo will store the new values and require them on future
@@ -255,7 +271,10 @@ The messages are:
 	config:
 		Outputs useful vdo configuration information. Mostly used
 		by users who want to recreate a similar VDO volume and
-		want to know the creation configuration used.
+		want to know the creation configuration used. Output version
+		3 contains physicalSize, logicalSize, slabSize,
+		compressionAlgorithm, the Zstd compressionLevel when applicable,
+		and index configuration fields.
 
 	dump:
 		Dumps many internal structures to the system log. This is
-- 
2.55.0


  reply	other threads:[~2026-07-23 16:14 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-07-23 16:13 [PATCH 1/2] vdo: add zstd compression support Rhajune Park
2026-07-23 16:13 ` Rhajune Park [this message]
2026-07-23 16:18   ` [PATCH 2/2] Documentation: device-mapper: document VDO zstd Matthew Sakai
2026-07-23 16:21     ` Matthew Sakai
2026-07-24  1:28 ` [PATCH 1/2] vdo: add zstd compression support Matthew Sakai
2026-07-27 13:43   ` June Park

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260723161350.1080473-2-june@pythonplayer123.dev \
    --to=june@pythonplayer123.dev \
    --cc=dm-devel@lists.linux.dev \
    --cc=msakai@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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.