linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: linux-doc@vger.kernel.org
Cc: Bagas Sanjaya <bagasdotme@gmail.com>,
	kernel test robot <lkp@intel.com>,
	Alasdair Kergon <agk@redhat.com>,
	Mike Snitzer <snitzer@kernel.org>,
	Jonathan Corbet <corbet@lwn.net>,
	Mikulas Patocka <mpatocka@redhat.com>,
	Ross Zwisler <zwisler@kernel.org>,
	Colin Ian King <colin.king@intel.com>,
	Dan Williams <dan.j.williams@intel.com>,
	Mauro Carvalho Chehab <mchehab@kernel.org>,
	dm-devel@redhat.com, stable@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: [PATCH 1/2] Documentation: dm writecache: Add missing blank line before optional parameters
Date: Sat,  2 Jul 2022 11:23:49 +0700	[thread overview]
Message-ID: <20220702042350.23187-2-bagasdotme@gmail.com> (raw)
In-Reply-To: <20220702042350.23187-1-bagasdotme@gmail.com>

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


  reply	other threads:[~2022-07-02  4:26 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-02  4:23 [PATCH 0/2] Documentation: dm writecache: documentation fixes Bagas Sanjaya
2022-07-02  4:23 ` Bagas Sanjaya [this message]
2022-07-02  4:23 ` [PATCH 2/2] Documentation: dm writecache: Render status list as list Bagas Sanjaya

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220702042350.23187-2-bagasdotme@gmail.com \
    --to=bagasdotme@gmail.com \
    --cc=agk@redhat.com \
    --cc=colin.king@intel.com \
    --cc=corbet@lwn.net \
    --cc=dan.j.williams@intel.com \
    --cc=dm-devel@redhat.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lkp@intel.com \
    --cc=mchehab@kernel.org \
    --cc=mpatocka@redhat.com \
    --cc=snitzer@kernel.org \
    --cc=stable@vger.kernel.org \
    --cc=zwisler@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).