Documentation/admin-guide/device-mapper/dm-pcache.rst | 8 ++++++++ 1 file changed, 8 insertions(+)
Hi all,
After merging the device-mapper tree, today's linux-next build (htmldocs)
failed like this:
Sphinx parallel build error:
docutils.utils.SystemMessage: Documentation/admin-guide/device-mapper/dm-pcache.rst:27: (SEVERE/4) Title overline & underline mismatch.
-------------------------------------------------------------------------------
Constructor
===========
Caused by commit
6fb8fbbaf147 ("dm-pcache: add persistent cache target in device-mapper")
I have applied the following fix patch for today (there may be better).
From: Stephen Rothwell <sfr@canb.auug.org.au>
Date: Fri, 15 Aug 2025 13:01:51 +1000
Subject: [PATCH] fix up for "dm-pcache: add persistent cache target in
device-mapper"
Sphinx parallel build error:
docutils.utils.SystemMessage: Documentation/admin-guide/device-mapper/dm-pcache.rst:27: (SEVERE/4) Title overline & underline mismatch.
Signed-off-by: Stephen Rothwell <sfr@canb.auug.org.au>
---
Documentation/admin-guide/device-mapper/dm-pcache.rst | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/Documentation/admin-guide/device-mapper/dm-pcache.rst b/Documentation/admin-guide/device-mapper/dm-pcache.rst
index e6433fab7bd6..550026219a6f 100644
--- a/Documentation/admin-guide/device-mapper/dm-pcache.rst
+++ b/Documentation/admin-guide/device-mapper/dm-pcache.rst
@@ -25,6 +25,7 @@ Quick feature summary
* *Log-structured write-back* that preserves backend crash-consistency
-------------------------------------------------------------------------------
+
Constructor
===========
@@ -58,6 +59,7 @@ The first time a pmem device is used, dm-pcache formats it automatically
(super-block, cache_info, etc.).
-------------------------------------------------------------------------------
+
Status line
===========
@@ -98,6 +100,7 @@ Field meanings
=============================== =============================================
-------------------------------------------------------------------------------
+
Messages
========
@@ -108,6 +111,7 @@ Messages
dmsetup message <dev> 0 gc_percent <0-90>
-------------------------------------------------------------------------------
+
Theory of operation
===================
@@ -152,6 +156,7 @@ range when it is inserted and stores it in the on-media key. Reads
validate the CRC before copying to the caller.
-------------------------------------------------------------------------------
+
Failure handling
================
@@ -164,6 +169,7 @@ Failure handling
use-after-free keys.
-------------------------------------------------------------------------------
+
Limitations & TODO
==================
@@ -173,6 +179,7 @@ Limitations & TODO
* Discard planned.
-------------------------------------------------------------------------------
+
Example workflow
================
@@ -197,5 +204,6 @@ Example workflow
dmsetup remove pcache_sdb
-------------------------------------------------------------------------------
+
``dm-pcache`` is under active development; feedback, bug reports and patches
are very welcome!
--
2.50.1
--
Cheers,
Stephen Rothwell
Hi
I've fixed the documentation indentations and folded it into the existing
commit in the linux-dm git.
Mikulas
On Fri, 15 Aug 2025, Stephen Rothwell wrote:
> Hi all,
>
> After merging the device-mapper tree, today's linux-next build (htmldocs)
> failed like this:
>
> Sphinx parallel build error:
> docutils.utils.SystemMessage: Documentation/admin-guide/device-mapper/dm-pcache.rst:27: (SEVERE/4) Title overline & underline mismatch.
>
> -------------------------------------------------------------------------------
> Constructor
> ===========
>
> Caused by commit
>
> 6fb8fbbaf147 ("dm-pcache: add persistent cache target in device-mapper")
>
> I have applied the following fix patch for today (there may be better).
>
> From: Stephen Rothwell <sfr@canb.auug.org.au>
> Date: Fri, 15 Aug 2025 13:01:51 +1000
> Subject: [PATCH] fix up for "dm-pcache: add persistent cache target in
> device-mapper"
>
> Sphinx parallel build error:
> docutils.utils.SystemMessage: Documentation/admin-guide/device-mapper/dm-pcache.rst:27: (SEVERE/4) Title overline & underline mismatch.
>
> Signed-off-by: Stephen Rothwell <sfr@canb.auug.org.au>
> ---
> Documentation/admin-guide/device-mapper/dm-pcache.rst | 8 ++++++++
> 1 file changed, 8 insertions(+)
>
> diff --git a/Documentation/admin-guide/device-mapper/dm-pcache.rst b/Documentation/admin-guide/device-mapper/dm-pcache.rst
> index e6433fab7bd6..550026219a6f 100644
> --- a/Documentation/admin-guide/device-mapper/dm-pcache.rst
> +++ b/Documentation/admin-guide/device-mapper/dm-pcache.rst
> @@ -25,6 +25,7 @@ Quick feature summary
> * *Log-structured write-back* that preserves backend crash-consistency
>
> -------------------------------------------------------------------------------
> +
> Constructor
> ===========
>
> @@ -58,6 +59,7 @@ The first time a pmem device is used, dm-pcache formats it automatically
> (super-block, cache_info, etc.).
>
> -------------------------------------------------------------------------------
> +
> Status line
> ===========
>
> @@ -98,6 +100,7 @@ Field meanings
> =============================== =============================================
>
> -------------------------------------------------------------------------------
> +
> Messages
> ========
>
> @@ -108,6 +111,7 @@ Messages
> dmsetup message <dev> 0 gc_percent <0-90>
>
> -------------------------------------------------------------------------------
> +
> Theory of operation
> ===================
>
> @@ -152,6 +156,7 @@ range when it is inserted and stores it in the on-media key. Reads
> validate the CRC before copying to the caller.
>
> -------------------------------------------------------------------------------
> +
> Failure handling
> ================
>
> @@ -164,6 +169,7 @@ Failure handling
> use-after-free keys.
>
> -------------------------------------------------------------------------------
> +
> Limitations & TODO
> ==================
>
> @@ -173,6 +179,7 @@ Limitations & TODO
> * Discard planned.
>
> -------------------------------------------------------------------------------
> +
> Example workflow
> ================
>
> @@ -197,5 +204,6 @@ Example workflow
> dmsetup remove pcache_sdb
>
> -------------------------------------------------------------------------------
> +
> ``dm-pcache`` is under active development; feedback, bug reports and patches
> are very welcome!
> --
> 2.50.1
>
> --
> Cheers,
> Stephen Rothwell
>
On Fri, Aug 15, 2025 at 01:05:43PM +1000, Stephen Rothwell wrote: > diff --git a/Documentation/admin-guide/device-mapper/dm-pcache.rst b/Documentation/admin-guide/device-mapper/dm-pcache.rst > index e6433fab7bd6..550026219a6f 100644 > --- a/Documentation/admin-guide/device-mapper/dm-pcache.rst > +++ b/Documentation/admin-guide/device-mapper/dm-pcache.rst > @@ -25,6 +25,7 @@ Quick feature summary > * *Log-structured write-back* that preserves backend crash-consistency > > ------------------------------------------------------------------------------- > + I think these unnecessary line breaks can be trimmed instead ([1]). Thanks. [1]: https://lore.kernel.org/dm-devel/20250815075622.23953-3-bagasdotme@gmail.com/ -- An old man doll... just what I always wanted! - Clara
© 2016 - 2026 Red Hat, Inc.