linux-kernel - Re: [PATCH v3] doc: Fix htmldocs build warnings of stallwarn.rst

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Date:   Mon, 28 Nov 2022 17:07:51 -0800
From:   "Paul E. McKenney" <paulmck@...nel.org>
To:     Akira Yokosawa <akiyks@...il.com>
Cc:     Zhen Lei <thunder.leizhen@...wei.com>, bagasdotme@...il.com,
        frederic@...nel.org, jiangshanlai@...il.com,
        joel@...lfernandes.org, josh@...htriplett.org,
        linux-kernel@...r.kernel.org, linux-next@...r.kernel.org,
        mathieu.desnoyers@...icios.com, quic_neeraju@...cinc.com,
        rcu@...r.kernel.org, rostedt@...dmis.org, sfr@...b.auug.org.au
Subject: Re: [PATCH v3] doc: Fix htmldocs build warnings of stallwarn.rst

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@...b.auug.org.au>
> > Signed-off-by: Zhen Lei <thunder.leizhen@...wei.com>
> 
> Tested "make htmldocs" on top of -rcu tree's dev.
> Resulting stallwarn.html looks much better!
> 
> Tested-by: Akira Yokosawa <akiyks@...il.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.