From: Akira Yokosawa <akiyks@gmail.com>
To: Zhen Lei <thunder.leizhen@huawei.com>,
"Paul E. McKenney" <paulmck@kernel.org>
Cc: bagasdotme@gmail.com, frederic@kernel.org,
jiangshanlai@gmail.com, joel@joelfernandes.org,
josh@joshtriplett.org, linux-kernel@vger.kernel.org,
linux-next@vger.kernel.org, mathieu.desnoyers@efficios.com,
quic_neeraju@quicinc.com, rcu@vger.kernel.org,
rostedt@goodmis.org, sfr@canb.auug.org.au,
Akira Yokosawa <akiyks@gmail.com>
Subject: Re: [PATCH v3] doc: Fix htmldocs build warnings of stallwarn.rst
Date: Sat, 26 Nov 2022 12:09:01 +0900 [thread overview]
Message-ID: <5689fac5-9ea9-a631-8ed0-a68dbbbe2466@gmail.com> (raw)
In-Reply-To: <20221124062204.1932-1-thunder.leizhen@huawei.com>
Hi,
On Thu, 24 Nov 2022 14:22:03 +0800, Zhen Lei wrote:
> Documentation/RCU/stallwarn.rst:
> 401: WARNING: Literal block expected; none found.
> 428: WARNING: Literal block expected; none found.
> 445: WARNING: Literal block expected; none found.
> 459: WARNING: Literal block expected; none found.
> 468: WARNING: Literal block expected; none found.
>
> The literal block need to be indented, so add two spaces to each line.
>
> In addition, ':', which is used as a boundary in the literal block, is
> replaced by '|'.
>
> Link: https://lore.kernel.org/linux-next/20221123163255.48653674@canb.auug.org.au/
> Fixes: 3d2788ba4573 ("doc: Document CONFIG_RCU_CPU_STALL_CPUTIME=y stall information")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Signed-off-by: Zhen Lei <thunder.leizhen@huawei.com>
Tested "make htmldocs" on top of -rcu tree's dev.
Resulting stallwarn.html looks much better!
Tested-by: Akira Yokosawa <akiyks@gmail.com>
Thanks, Akira
> ---
> Documentation/RCU/stallwarn.rst | 56 ++++++++++++++++++---------------
> 1 file changed, 30 insertions(+), 26 deletions(-)
>
> v2 --> v3:
> 1. Add "Link:", "Fixes:", "Reported-by:".
> 2. Remove a orphaned pipe (|).
> 3. Change ". ::" to "::"
>
> v1 --> v2:
> For the case that both colons need to be deleted, change "::" to expanded
> form or partially minimized form.
next prev parent reply other threads:[~2022-11-26 3:09 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-24 6:22 [PATCH v3] doc: Fix htmldocs build warnings of stallwarn.rst Zhen Lei
2022-11-26 1:30 ` Leizhen (ThunderTown)
2022-11-28 4:03 ` Bagas Sanjaya
2022-11-26 3:09 ` Akira Yokosawa [this message]
2022-11-29 1:07 ` Paul E. McKenney
2022-11-28 4:08 ` Bagas Sanjaya
2022-11-28 7:05 ` Leizhen (ThunderTown)
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=5689fac5-9ea9-a631-8ed0-a68dbbbe2466@gmail.com \
--to=akiyks@gmail.com \
--cc=bagasdotme@gmail.com \
--cc=frederic@kernel.org \
--cc=jiangshanlai@gmail.com \
--cc=joel@joelfernandes.org \
--cc=josh@joshtriplett.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-next@vger.kernel.org \
--cc=mathieu.desnoyers@efficios.com \
--cc=paulmck@kernel.org \
--cc=quic_neeraju@quicinc.com \
--cc=rcu@vger.kernel.org \
--cc=rostedt@goodmis.org \
--cc=sfr@canb.auug.org.au \
--cc=thunder.leizhen@huawei.com \
/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