Documentation fixes for dm-pcache
Subsystems (3)
cover Documentation fixes for dm-pcache
Hi,
Here are docs fixes for dm-pcache as reported in linux-next ([1], [2]).
Enjoy!
[1]: https://lore.kernel.org/linux-next/[email protected]/
[2]: https://lore.kernel.org/linux-next/[email protected]/
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
Signature · 1 line
An old man doll... just what I always wanted! - Clara
PATCH 1/3 dm-pcache: Remove unnecessary line breaks
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.
--- Documentation/admin-guide/device-mapper/dm-pcache.rst | 8 -------- 1 file changed, 8 deletions(-)
Documentation/admin-guide/device-mapper/dm-pcache.rst +0 -8
@@ -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!
Signature · 1 line
An old man doll... just what I always wanted! - Clara
PATCH 2/3 dm-pcache: Use bullet list for data_crc constructor argument
In reply to Bagas SanjayaSphinx 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.
--- Documentation/admin-guide/device-mapper/dm-pcache.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-)
Documentation/admin-guide/device-mapper/dm-pcache.rst +4 -3
@@ -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
Signature · 1 line
An old man doll... just what I always wanted! - Clara
PATCH 3/3 Documentation: device-mapper: Add dm-pcache docs to toctree index
In reply to Bagas SanjayaSphinx 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.
--- Documentation/admin-guide/device-mapper/index.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/admin-guide/device-mapper/index.rst +1 -0
@@ -18,6 +18,7 @@ Device Mapper dm-integrity dm-io dm-log + dm-pcache dm-queue-length dm-raid dm-service-time
Signature · 1 line
An old man doll... just what I always wanted! - Clara
Quoted 20 lines · 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/[email protected]/
[2]: https://lore.kernel.org/linux-next/[email protected]/Bagas Sanjaya (3):
dm-pcache: Remove unnecessary line breaks
dm-pcache: Use bullet list fordata_crcconstructor 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
Quoted 9 lines · 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/[email protected]/
[2]: https://lore.kernel.org/linux-next/[email protected]/
Quoted 8 lines
Bagas Sanjaya (3):
dm-pcache: Remove unnecessary line breaks
dm-pcache: Use bullet list fordata_crcconstructor 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.
Signature · 1 line
~Randy