All of lore.kernel.org
 help / color / mirror / Atom feed
From: Yanteng Si <siyanteng@loongson.cn>
To: corbet@lwn.net, swboyd@chromium.org, rostedt@goodmis.org
Cc: linux-doc@vger.kernel.org, senozhatsky@chromium.org,
	andriy.shevchenko@linux.intel.com, linux@rasmusvillemoes.dk,
	siyanteng01@gmail.com, Yanteng Si <siyanteng@loongson.cn>
Subject: [PATCH v2] docs: core-api: Documentation build warning fix
Date: Fri, 28 May 2021 18:00:16 +0800	[thread overview]
Message-ID: <20210528100016.3017663-1-siyanteng@loongson.cn> (raw)

commit 821c734b5b07 ("module: add printk formats to add module build ID to stacktraces")
Causes the following warning:
Documentation/core-api/printk-formats.rst:137: WARNING: Unexpected indentation.
Documentation/core-api/printk-formats.rst:138: WARNING: Block quote ends without a blank line; unexpected unindent.

So, add a blank line to the end of "::".

Signed-off-by: Yanteng Si <siyanteng@loongson.cn>
Reviewed-by: Stephen Boyd <swboyd@chromium.org>
---
v2:
* use the canonical format for referring to other commits
* pick Stephen's Reviewed-by tag

 Documentation/core-api/printk-formats.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/core-api/printk-formats.rst b/Documentation/core-api/printk-formats.rst
index a68730e7cfac..38ec2b05e54f 100644
--- a/Documentation/core-api/printk-formats.rst
+++ b/Documentation/core-api/printk-formats.rst
@@ -131,6 +131,7 @@ printed after the symbol name with an extra ``b`` appended to the end of the
 specifier.
 
 ::
+
 	%pS	versatile_init+0x0/0x110 [module_name]
 	%pSb	versatile_init+0x0/0x110 [module_name ed5019fdf5e53be37cb1ba7899292d7e143b259e]
 	%pSRb	versatile_init+0x9/0x110 [module_name ed5019fdf5e53be37cb1ba7899292d7e143b259e]
-- 
2.27.0


             reply	other threads:[~2021-05-28 10:00 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-28 10:00 Yanteng Si [this message]
2021-05-28 10:41 ` [PATCH v2] docs: core-api: Documentation build warning fix Andy Shevchenko

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=20210528100016.3017663-1-siyanteng@loongson.cn \
    --to=siyanteng@loongson.cn \
    --cc=andriy.shevchenko@linux.intel.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux@rasmusvillemoes.dk \
    --cc=rostedt@goodmis.org \
    --cc=senozhatsky@chromium.org \
    --cc=siyanteng01@gmail.com \
    --cc=swboyd@chromium.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 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.