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

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

[Bagas Sanjaya]

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@gmail.com>
---
 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
-- 
An old man doll... just what I always wanted! - Clara

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

[Randy Dunlap]

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@gmail.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

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.

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

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

[Paul E. McKenney]

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@gmail.com>
> 
> Reviewed-by: Randy Dunlap <rdunlap@infradead.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