Skip to contentSkip to conversation

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

PATCH In review Bagas Sanjaya 3 participants 3 messages Aug 19, 2025

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

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

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")
---
 Documentation/RCU/torture.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/RCU/torture.rst +1 -1
index 4b1f99c4181fee..cc57d01ed700ff 100644
@@ -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

Signature · 1 line
An old man doll... just what I always wanted! - Clara
reviewer Reviewed-by on v1 1/1
#1 lore raw
Quoted 8 lines · 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")

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.

Quoted 19 lines
---
 Documentation/RCU/torture.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/RCU/torture.rst +1 -1
index 4b1f99c4181fee..cc57d01ed700ff 100644
@@ -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

Signature · 1 line
~Randy
maintainer
#2 lore raw
Quoted 7 lines · Randy Dunlap
Quoted 4 lines · 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.

Quoted 6 lines
Quoted 4 lines

Wrap it like the rest.

Fixes 0c208a793022 ("doc: Update torture.rst")

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

Quoted 6 lines

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

Quoted 24 lines

Thanks.

Quoted 19 lines
---
 Documentation/RCU/torture.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/RCU/torture.rst +1 -1
index 4b1f99c4181fee..cc57d01ed700ff 100644
@@ -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

Signature · 1 line
~Randy