Two small documentation fixes for writecache functionality of device mapper. The shortlog below should be self-explanatory.
Cc: Alasdair Kergon agk@redhat.com Cc: Mike Snitzer snitzer@kernel.org Cc: Jonathan Corbet corbet@lwn.net Cc: Mikulas Patocka mpatocka@redhat.com Cc: Ross Zwisler zwisler@kernel.org Cc: Colin Ian King colin.king@intel.com Cc: Dan Williams dan.j.williams@intel.com Cc: Mauro Carvalho Chehab mchehab@kernel.org Cc: dm-devel@redhat.com Cc: stable@vger.kernel.org Cc: linux-kernel@vger.kernel.org
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
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.
Link: https://lore.kernel.org/linux-doc/202207020824.oMJMSB8R-lkp@intel.com/ Fixes: d284f8248c72d0 ("dm writecache: support optional offset for start of device") Reported-by: kernel test robot lkp@intel.com Cc: Alasdair Kergon agk@redhat.com Cc: Mike Snitzer snitzer@kernel.org Cc: Jonathan Corbet corbet@lwn.net Cc: Mikulas Patocka mpatocka@redhat.com Cc: Ross Zwisler zwisler@kernel.org Cc: Colin Ian King colin.king@intel.com Cc: Dan Williams dan.j.williams@intel.com Cc: Mauro Carvalho Chehab mchehab@kernel.org Cc: dm-devel@redhat.com Cc: stable@vger.kernel.org # v4.19+ Cc: linux-kernel@vger.kernel.org Signed-off-by: Bagas Sanjaya bagasdotme@gmail.com --- Documentation/admin-guide/device-mapper/writecache.rst | 1 + 1 file changed, 1 insertion(+)
diff --git a/Documentation/admin-guide/device-mapper/writecache.rst b/Documentation/admin-guide/device-mapper/writecache.rst index 10429779a91abc..6bf78b0446acba 100644 --- a/Documentation/admin-guide/device-mapper/writecache.rst +++ b/Documentation/admin-guide/device-mapper/writecache.rst @@ -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)
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 agk@redhat.com Cc: Mike Snitzer snitzer@kernel.org Cc: Jonathan Corbet corbet@lwn.net Cc: Mikulas Patocka mpatocka@redhat.com Cc: Ross Zwisler zwisler@kernel.org Cc: Colin Ian King colin.king@intel.com Cc: Dan Williams dan.j.williams@intel.com Cc: Mauro Carvalho Chehab mchehab@kernel.org Cc: dm-devel@redhat.com Cc: stable@vger.kernel.org # v4.19+ Cc: linux-kernel@vger.kernel.org Signed-off-by: Bagas Sanjaya bagasdotme@gmail.com --- Documentation/admin-guide/device-mapper/writecache.rst | 1 + 1 file changed, 1 insertion(+)
diff --git a/Documentation/admin-guide/device-mapper/writecache.rst b/Documentation/admin-guide/device-mapper/writecache.rst index 6bf78b0446acba..2104812f028129 100644 --- a/Documentation/admin-guide/device-mapper/writecache.rst +++ b/Documentation/admin-guide/device-mapper/writecache.rst @@ -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
linux-stable-mirror@lists.linaro.org
-
Bagas Sanjaya