Skip to contentSkip to conversation

Documentation: dm writecache: documentation fixes

PATCH New Bagas Sanjaya 1 participant 3 messages Jul 2, 2022

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

cover Documentation: dm writecache: documentation fixes

Two small documentation fixes for writecache functionality of device mapper. The shortlog below should be self-explanatory.

Cc Alasdair Kergon <[email protected]>
Cc Mike Snitzer <[email protected]>
Cc Jonathan Corbet <[email protected]>
Cc Mikulas Patocka <[email protected]>
Cc Ross Zwisler <[email protected]>
Cc Colin Ian King <[email protected]>
Cc Dan Williams <[email protected]>
Cc Mauro Carvalho Chehab <[email protected]>

Bagas Sanjaya (2):
Documentation: dm writecache: Add missing blank line before optional
parameters
Documentation: dm writecache: Render status list as list

 Documentation/admin-guide/device-mapper/writecache.rst | 2 ++
 1 file changed, 2 insertions(+)

base-commit: 089866061428ec9bf67221247c936792078c41a4

Signature · 1 line
An old man doll... just what I always wanted! - Clara
#1 lore raw

PATCH 1/2 Documentation: dm writecache: Add missing blank line before optional parameters

kernel test robot reported htmldocs warning which first happened 1 year ago:

Documentation/admin-guide/device-mapper/writecache.rst:23: WARNING: Unexpected indentation.

The warning above is due to missing blank line between numbered list (at n. 5) and optional parameters list (as definition list).

Add the blank line to suppress the warning.

Fixes d284f8248c72d0 ("dm writecache: support optional offset for start of device")
Cc Alasdair Kergon <[email protected]>
Cc Mike Snitzer <[email protected]>
Cc Jonathan Corbet <[email protected]>
Cc Mikulas Patocka <[email protected]>
Cc Ross Zwisler <[email protected]>
Cc Colin Ian King <[email protected]>
Cc Dan Williams <[email protected]>
Cc Mauro Carvalho Chehab <[email protected]>
Cc [email protected] # v4.19+
---
 Documentation/admin-guide/device-mapper/writecache.rst | 1 +
 1 file changed, 1 insertion(+)
Documentation/admin-guide/device-mapper/writecache.rst +1 -0
index 10429779a91abc..6bf78b0446acba 100644
@@ -20,6 +20,7 @@ Constructor parameters:
    size)
 5. the number of optional parameters (the parameters with an argument
    count as two)
+
 	start_sector n		(default: 0)
 		offset from the start of cache device in 512-byte sectors
 	high_watermark n	(default: 50)
Signature · 1 line
An old man doll... just what I always wanted! - Clara
#2 lore raw

PATCH 2/2 Documentation: dm writecache: Render status list as list

In reply to Bagas Sanjaya

The status list isn't rendered as list, but rather as normal paragraph, because there is missing blank line between "Status:" line and the list.

Fix the issue by adding the blank line separator.

Fixes 48debafe4f2fea ("dm: add writecache target")
Cc Alasdair Kergon <[email protected]>
Cc Mike Snitzer <[email protected]>
Cc Jonathan Corbet <[email protected]>
Cc Mikulas Patocka <[email protected]>
Cc Ross Zwisler <[email protected]>
Cc Colin Ian King <[email protected]>
Cc Dan Williams <[email protected]>
Cc Mauro Carvalho Chehab <[email protected]>
Cc [email protected] # v4.19+
---
 Documentation/admin-guide/device-mapper/writecache.rst | 1 +
 1 file changed, 1 insertion(+)
Documentation/admin-guide/device-mapper/writecache.rst +1 -0
index 6bf78b0446acba..2104812f028129 100644
@@ -75,6 +75,7 @@ Constructor parameters:
 		the origin volume in the last n milliseconds
 
 Status:
+
 1. error indicator - 0 if there was no error, otherwise error number
 2. the number of blocks
 3. the number of free blocks
Signature · 1 line
An old man doll... just what I always wanted! - Clara