Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Date:   Mon, 28 Nov 2022 17:07:51 -0800
From:   "Paul E. McKenney" <paulmck@kernel.org>
To:     Akira Yokosawa <akiyks@gmail.com>
Cc:     Zhen Lei <thunder.leizhen@huawei.com>, 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
Subject: Re: [PATCH v3] doc: Fix htmldocs build warnings of stallwarn.rst
Message-ID: <20221129010751.GA72848@paulmck-ThinkPad-P17-Gen-1>
Reply-To: paulmck@kernel.org
References: <20221124062204.1932-1-thunder.leizhen@huawei.com>
 <5689fac5-9ea9-a631-8ed0-a68dbbbe2466@gmail.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <5689fac5-9ea9-a631-8ed0-a68dbbbe2466@gmail.com>
Precedence: bulk

On Sat, Nov 26, 2022 at 12:09:01PM +0900, Akira Yokosawa wrote:
> 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>

Queued for further testing and review, thank you all!

							Thanx, Paul

>         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.