From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Linux Kernel Mailing List <linux-kernel@vger.kernel.org>,
Linux Documentation <linux-doc@vger.kernel.org>,
Linux Device Mapper <dm-devel@lists.linux.dev>
Cc: Dongsheng Yang <dongsheng.yang@linux.dev>,
Zheng Gu <cengku@gmail.com>, Alasdair Kergon <agk@redhat.com>,
Mike Snitzer <snitzer@kernel.org>,
Mikulas Patocka <mpatocka@redhat.com>,
Bagas Sanjaya <bagasdotme@gmail.com>,
Stephen Rothwell <sfr@canb.auug.org.au>
Subject: [PATCH 2/3] dm-pcache: Use bullet list for data_crc constructor argument
Date: Fri, 15 Aug 2025 14:56:15 +0700 [thread overview]
Message-ID: <20250815075622.23953-4-bagasdotme@gmail.com> (raw)
In-Reply-To: <20250815075622.23953-2-bagasdotme@gmail.com>
Sphinx reports indentation warnings on data_crc argument description:
Documentation/admin-guide/device-mapper/dm-pcache.rst:44: ERROR: Unexpected indentation. [docutils]
Documentation/admin-guide/device-mapper/dm-pcache.rst:46: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
Fix the warning by using proper bullet list syntax.
Fixes: 6fb8fbbaf147 ("dm-pcache: add persistent cache target in device-mapper")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20250815131115.45518c74@canb.auug.org.au/
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/admin-guide/device-mapper/dm-pcache.rst | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/Documentation/admin-guide/device-mapper/dm-pcache.rst b/Documentation/admin-guide/device-mapper/dm-pcache.rst
index ecd015be798243..02cea738ae131b 100644
--- a/Documentation/admin-guide/device-mapper/dm-pcache.rst
+++ b/Documentation/admin-guide/device-mapper/dm-pcache.rst
@@ -40,9 +40,10 @@ Constructor
``cache_mode`` Optional, Only ``writeback`` is accepted at the moment.
``data_crc`` Optional, default to ``false``
- ``true`` – store CRC32 for every cached entry and
- verify on reads
- ``false`` – skip CRC (faster)
+
+ * ``true`` – store CRC32 for every cached entry and
+ verify on reads
+ * ``false`` – skip CRC (faster)
========================= ====================================================
Example
--
An old man doll... just what I always wanted! - Clara
next prev parent reply other threads:[~2025-08-15 7:56 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-08-15 7:56 [PATCH 0/3] Documentation fixes for dm-pcache Bagas Sanjaya
2025-08-15 7:56 ` [PATCH 1/3] dm-pcache: Remove unnecessary line breaks Bagas Sanjaya
2025-08-15 7:56 ` Bagas Sanjaya [this message]
2025-08-15 7:56 ` [PATCH 3/3] Documentation: device-mapper: Add dm-pcache docs to toctree index Bagas Sanjaya
2025-08-15 13:00 ` [PATCH 0/3] Documentation fixes for dm-pcache Dongsheng Yang
2025-08-15 17:20 ` Randy Dunlap
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=20250815075622.23953-4-bagasdotme@gmail.com \
--to=bagasdotme@gmail.com \
--cc=agk@redhat.com \
--cc=cengku@gmail.com \
--cc=dm-devel@lists.linux.dev \
--cc=dongsheng.yang@linux.dev \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mpatocka@redhat.com \
--cc=sfr@canb.auug.org.au \
--cc=snitzer@kernel.org \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).