* [PATCH 0/2] Documentation: dm writecache: documentation fixes
@ 2022-07-02 4:23 ` Bagas Sanjaya
0 siblings, 0 replies; 6+ messages in thread
From: Bagas Sanjaya @ 2022-07-02 4:23 UTC (permalink / raw)
To: linux-doc
Cc: Bagas Sanjaya, Alasdair Kergon, Mike Snitzer, Jonathan Corbet,
Mikulas Patocka, Ross Zwisler, Colin Ian King, Dan Williams,
Mauro Carvalho Chehab, dm-devel, stable, linux-kernel
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
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply [flat|nested] 6+ messages in thread
* [dm-devel] [PATCH 0/2] Documentation: dm writecache: documentation fixes
@ 2022-07-02 4:23 ` Bagas Sanjaya
0 siblings, 0 replies; 6+ messages in thread
From: Bagas Sanjaya @ 2022-07-02 4:23 UTC (permalink / raw)
To: linux-doc
Cc: Mauro Carvalho Chehab, Jonathan Corbet, Mike Snitzer,
linux-kernel, stable, dm-devel, Mikulas Patocka, Bagas Sanjaya,
Ross Zwisler, Dan Williams, Colin Ian King, Alasdair Kergon
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
--
An old man doll... just what I always wanted! - Clara
--
dm-devel mailing list
dm-devel@redhat.com
https://listman.redhat.com/mailman/listinfo/dm-devel
^ permalink raw reply [flat|nested] 6+ messages in thread
* [PATCH 1/2] Documentation: dm writecache: Add missing blank line before optional parameters
2022-07-02 4:23 ` [dm-devel] " Bagas Sanjaya
@ 2022-07-02 4:23 ` Bagas Sanjaya
-1 siblings, 0 replies; 6+ messages in thread
From: Bagas Sanjaya @ 2022-07-02 4:23 UTC (permalink / raw)
To: linux-doc
Cc: Bagas Sanjaya, kernel test robot, Alasdair Kergon, Mike Snitzer,
Jonathan Corbet, Mikulas Patocka, Ross Zwisler, Colin Ian King,
Dan Williams, Mauro Carvalho Chehab, dm-devel, stable,
linux-kernel
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)
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [dm-devel] [PATCH 1/2] Documentation: dm writecache: Add missing blank line before optional parameters
@ 2022-07-02 4:23 ` Bagas Sanjaya
0 siblings, 0 replies; 6+ messages in thread
From: Bagas Sanjaya @ 2022-07-02 4:23 UTC (permalink / raw)
To: linux-doc
Cc: Mauro Carvalho Chehab, kernel test robot, Jonathan Corbet,
Mike Snitzer, linux-kernel, stable, dm-devel, Mikulas Patocka,
Bagas Sanjaya, Ross Zwisler, Dan Williams, Colin Ian King,
Alasdair Kergon
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)
--
An old man doll... just what I always wanted! - Clara
--
dm-devel mailing list
dm-devel@redhat.com
https://listman.redhat.com/mailman/listinfo/dm-devel
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [PATCH 2/2] Documentation: dm writecache: Render status list as list
2022-07-02 4:23 ` [dm-devel] " Bagas Sanjaya
@ 2022-07-02 4:23 ` Bagas Sanjaya
-1 siblings, 0 replies; 6+ messages in thread
From: Bagas Sanjaya @ 2022-07-02 4:23 UTC (permalink / raw)
To: linux-doc
Cc: Bagas Sanjaya, Alasdair Kergon, Mike Snitzer, Jonathan Corbet,
Mikulas Patocka, Ross Zwisler, Colin Ian King, Dan Williams,
Mauro Carvalho Chehab, dm-devel, stable, linux-kernel
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
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [dm-devel] [PATCH 2/2] Documentation: dm writecache: Render status list as list
@ 2022-07-02 4:23 ` Bagas Sanjaya
0 siblings, 0 replies; 6+ messages in thread
From: Bagas Sanjaya @ 2022-07-02 4:23 UTC (permalink / raw)
To: linux-doc
Cc: Mauro Carvalho Chehab, Jonathan Corbet, Mike Snitzer,
linux-kernel, stable, dm-devel, Mikulas Patocka, Bagas Sanjaya,
Ross Zwisler, Dan Williams, Colin Ian King, Alasdair Kergon
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
--
An old man doll... just what I always wanted! - Clara
--
dm-devel mailing list
dm-devel@redhat.com
https://listman.redhat.com/mailman/listinfo/dm-devel
^ permalink raw reply related [flat|nested] 6+ messages in thread
end of thread, other threads:[~2022-07-07 7:28 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-07-02 4:23 [PATCH 0/2] Documentation: dm writecache: documentation fixes Bagas Sanjaya
2022-07-02 4:23 ` [dm-devel] " Bagas Sanjaya
2022-07-02 4:23 ` [PATCH 1/2] Documentation: dm writecache: Add missing blank line before optional parameters Bagas Sanjaya
2022-07-02 4:23 ` [dm-devel] " Bagas Sanjaya
2022-07-02 4:23 ` [PATCH 2/2] Documentation: dm writecache: Render status list as list Bagas Sanjaya
2022-07-02 4:23 ` [dm-devel] " Bagas Sanjaya
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.