linux-kernel - Re: [PATCH] Documentation: RCU: Wrap kvm-remote.sh rerun snippet in literal code block

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]

Message-ID: <3b5d4337-9e19-40b5-a8cb-021c6afab9a1@paulmck-laptop>
Date: Tue, 19 Aug 2025 08:40:15 -0700
From: "Paul E. McKenney" <paulmck@...nel.org>
To: Randy Dunlap <rdunlap@...radead.org>
Cc: Bagas Sanjaya <bagasdotme@...il.com>,
	Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
	Linux Documentation <linux-doc@...r.kernel.org>,
	Linux RCU <rcu@...r.kernel.org>,
	Davidlohr Bueso <dave@...olabs.net>,
	Josh Triplett <josh@...htriplett.org>,
	Jonathan Corbet <corbet@....net>,
	Steven Rostedt <rostedt@...dmis.org>,
	Mathieu Desnoyers <mathieu.desnoyers@...icios.com>,
	Lai Jiangshan <jiangshanlai@...il.com>,
	Frederic Weisbecker <frederic@...nel.org>,
	Neeraj Upadhyay <neeraj.upadhyay@...nel.org>,
	Joel Fernandes <joelagnelf@...dia.com>,
	Boqun Feng <boqun.feng@...il.com>,
	Uladzislau Rezki <urezki@...il.com>, Zqiang <qiang.zhang@...ux.dev>
Subject: Re: [PATCH] Documentation: RCU: Wrap kvm-remote.sh rerun snippet in
 literal code block

On Mon, Aug 18, 2025 at 09:16:04PM -0700, Randy Dunlap wrote:
> 
> 
> On 8/18/25 5:45 PM, Bagas Sanjaya wrote:
> > Unlike other kvm*.sh snippets in RCU torture test documentation,
> > kvm-remote.sh rerun snippet isn't formatted as literal code block,
> > causing it to be definition list instead in htmldocs output.
> > 
> > Wrap it like the rest.
> > 
> > Fixes: 0c208a793022 ("doc: Update torture.rst")
> > Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
> 
> Reviewed-by: Randy Dunlap <rdunlap@...radead.org>

Thank you, and I will apply this on my next rebase.

> BTW, 20 lines above this change, the text says:
> 
>   If you the following command works::
> 
> Do you have any idea what word is missing there?
> or maybe Paul can make a suggestion.

I suggest dropping the "you".  In fact, I just created a commit with
your Reported-by doing just that.

Thank you, and now to find that brown paper bag...

							Thanx, Paul

> Thanks.
> 
> > ---
> >  Documentation/RCU/torture.rst | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/Documentation/RCU/torture.rst b/Documentation/RCU/torture.rst
> > index 4b1f99c4181fee..cc57d01ed700ff 100644
> > --- a/Documentation/RCU/torture.rst
> > +++ b/Documentation/RCU/torture.rst
> > @@ -364,7 +364,7 @@ systems must come first.
> >  The kvm.sh ``--dryrun scenarios`` argument is useful for working out
> >  how many scenarios may be run in one batch across a group of systems.
> >  
> > -You can also re-run a previous remote run in a manner similar to kvm.sh:
> > +You can also re-run a previous remote run in a manner similar to kvm.sh::
> >  
> >  	kvm-remote.sh "system0 system1 system2 system3 system4 system5" \
> >  		tools/testing/selftests/rcutorture/res/2022.11.03-11.26.28-remote \
> > 
> > base-commit: 61399e0c5410567ef60cb1cda34cca42903842e3
> 
> -- 
> ~Randy