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 <s...@canb.auug.org.au> Closes: https://lore.kernel.org/linux-next/20250815130543.31121...@canb.auug.org.au/ Signed-off-by: Bagas Sanjaya <bagasdo...@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