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 1/3] dm-pcache: Remove unnecessary line breaks
Date: Fri, 15 Aug 2025 14:56:14 +0700 [thread overview]
Message-ID: <20250815075622.23953-3-bagasdotme@gmail.com> (raw)
In-Reply-To: <20250815075622.23953-2-bagasdotme@gmail.com>
Sphinx confuses line breaks that are placed right before section
headings with title heading overline. This causes htmldocs build to spit
out markup error:
Documentation/admin-guide/device-mapper/dm-pcache.rst:27: CRITICAL: Title overline & underline mismatch.
-------------------------------------------------------------------------------
Constructor
=========== [docutils]
reStructuredText markup error!
Remove line breaks to keep htmldocs building.
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/20250815130543.3112144e@canb.auug.org.au/
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/admin-guide/device-mapper/dm-pcache.rst | 8 --------
1 file changed, 8 deletions(-)
diff --git a/Documentation/admin-guide/device-mapper/dm-pcache.rst b/Documentation/admin-guide/device-mapper/dm-pcache.rst
index e6433fab7bd64b..ecd015be798243 100644
--- a/Documentation/admin-guide/device-mapper/dm-pcache.rst
+++ b/Documentation/admin-guide/device-mapper/dm-pcache.rst
@@ -24,7 +24,6 @@ Quick feature summary
* Pure *DAX path* I/O – no extra BIO round-trips
* *Log-structured write-back* that preserves backend crash-consistency
--------------------------------------------------------------------------------
Constructor
===========
@@ -57,7 +56,6 @@ Example
The first time a pmem device is used, dm-pcache formats it automatically
(super-block, cache_info, etc.).
--------------------------------------------------------------------------------
Status line
===========
@@ -97,7 +95,6 @@ Field meanings
``key_tail`` First key-set that may be reclaimed by GC.
=============================== =============================================
--------------------------------------------------------------------------------
Messages
========
@@ -107,7 +104,6 @@ Messages
dmsetup message <dev> 0 gc_percent <0-90>
--------------------------------------------------------------------------------
Theory of operation
===================
@@ -151,7 +147,6 @@ If ``data_crc is enabled`` dm-pcache computes a CRC32 over every cached data
range when it is inserted and stores it in the on-media key. Reads
validate the CRC before copying to the caller.
--------------------------------------------------------------------------------
Failure handling
================
@@ -163,7 +158,6 @@ Failure handling
rebuild the in-core trees; every segment’s generation guards against
use-after-free keys.
--------------------------------------------------------------------------------
Limitations & TODO
==================
@@ -172,7 +166,6 @@ Limitations & TODO
* Table reload is not supported currently.
* Discard planned.
--------------------------------------------------------------------------------
Example workflow
================
@@ -196,6 +189,5 @@ Example workflow
umount /mnt
dmsetup remove pcache_sdb
--------------------------------------------------------------------------------
``dm-pcache`` is under active development; feedback, bug reports and patches
are very welcome!
--
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 ` Bagas Sanjaya [this message]
2025-08-15 7:56 ` [PATCH 2/3] dm-pcache: Use bullet list for data_crc constructor argument Bagas Sanjaya
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-3-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).