Documentation: dm writecache: documentation fixes
Subsystems (3)
cover Documentation: dm writecache: documentation fixes
Two small documentation fixes for writecache functionality of device mapper. The shortlog below should be self-explanatory.
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
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.
--- Documentation/admin-guide/device-mapper/writecache.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/admin-guide/device-mapper/writecache.rst +1 -0
@@ -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
PATCH 2/2 Documentation: dm writecache: Render status list as list
In reply to Bagas SanjayaThe 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.
--- Documentation/admin-guide/device-mapper/writecache.rst | 1 + 1 file changed, 1 insertion(+)
Documentation/admin-guide/device-mapper/writecache.rst +1 -0
@@ -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