[PATCH 0/3] Documentation fixes for dm-pcache

[PATCH 0/3] Documentation fixes for dm-pcache

[Bagas Sanjaya]

Hi,

Here are docs fixes for dm-pcache as reported in linux-next ([1], [2]).

Enjoy!

[1]: https://lore.kernel.org/linux-next/20250815130543.3112144e@canb.auug.org.au/
[2]: https://lore.kernel.org/linux-next/20250815131115.45518c74@canb.auug.org.au/

Bagas Sanjaya (3):
  dm-pcache: Remove unnecessary line breaks
  dm-pcache: Use bullet list for data_crc constructor argument
  Documentation: device-mapper: Add dm-pcache docs to toctree index

 .../admin-guide/device-mapper/dm-pcache.rst       | 15 ++++-----------
 Documentation/admin-guide/device-mapper/index.rst |  1 +
 2 files changed, 5 insertions(+), 11 deletions(-)


base-commit: 6fb8fbbaf147fe4153177320ee354c457605800a
-- 
An old man doll... just what I always wanted! - Clara

[PATCH 1/3] dm-pcache: Remove unnecessary line breaks

[Bagas Sanjaya]

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

[PATCH 2/3] dm-pcache: Use bullet list for data_crc constructor argument

[Bagas Sanjaya]

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

[PATCH 3/3] Documentation: device-mapper: Add dm-pcache docs to toctree index

[Bagas Sanjaya]

Sphinx reports missing toctree entry warning:

Documentation/admin-guide/device-mapper/dm-pcache.rst: WARNING: document isn't included in any toctree [toc.not_included]

Add dm-pcache docs to device-mapper toctree to fix the warning.

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/index.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/admin-guide/device-mapper/index.rst b/Documentation/admin-guide/device-mapper/index.rst
index cc5aec8615765e..f1c1f4b824bafe 100644
--- a/Documentation/admin-guide/device-mapper/index.rst
+++ b/Documentation/admin-guide/device-mapper/index.rst
@@ -18,6 +18,7 @@ Device Mapper
     dm-integrity
     dm-io
     dm-log
+    dm-pcache
     dm-queue-length
     dm-raid
     dm-service-time
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH 0/3] Documentation fixes for dm-pcache

[Dongsheng Yang]

Acked-by: Dongsheng Yang <dongsheng.yang@linux.dev>


在 8/15/2025 3:56 PM, Bagas Sanjaya 写道:
> Hi,
>
> Here are docs fixes for dm-pcache as reported in linux-next ([1], [2]).
>
> Enjoy!
>
> [1]: https://lore.kernel.org/linux-next/20250815130543.3112144e@canb.auug.org.au/
> [2]: https://lore.kernel.org/linux-next/20250815131115.45518c74@canb.auug.org.au/
>
> Bagas Sanjaya (3):
>    dm-pcache: Remove unnecessary line breaks
>    dm-pcache: Use bullet list for data_crc constructor argument
>    Documentation: device-mapper: Add dm-pcache docs to toctree index
>
>   .../admin-guide/device-mapper/dm-pcache.rst       | 15 ++++-----------
>   Documentation/admin-guide/device-mapper/index.rst |  1 +
>   2 files changed, 5 insertions(+), 11 deletions(-)
>
>
> base-commit: 6fb8fbbaf147fe4153177320ee354c457605800a

Re: [PATCH 0/3] Documentation fixes for dm-pcache

[Randy Dunlap]

On 8/15/25 12:56 AM, Bagas Sanjaya wrote:
> Hi,
> 
> Here are docs fixes for dm-pcache as reported in linux-next ([1], [2]).
> 
> Enjoy!
> 
> [1]: https://lore.kernel.org/linux-next/20250815130543.3112144e@canb.auug.org.au/
> [2]: https://lore.kernel.org/linux-next/20250815131115.45518c74@canb.auug.org.au/
> 
> Bagas Sanjaya (3):
>   dm-pcache: Remove unnecessary line breaks
>   dm-pcache: Use bullet list for data_crc constructor argument
>   Documentation: device-mapper: Add dm-pcache docs to toctree index
> 
>  .../admin-guide/device-mapper/dm-pcache.rst       | 15 ++++-----------
>  Documentation/admin-guide/device-mapper/index.rst |  1 +
>  2 files changed, 5 insertions(+), 11 deletions(-)


LGTM. Thanks.

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
-- 
~Randy