Skip to contentSkip to conversation

docs/devel/writing-monitor-commands: Replace obsolete STEXI/ETEXI tags

PATCH In review Thomas Huth 2 participants 2 messages May 6, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docs/devel/writing-monitor-commands: Replace obsolete STEXI/ETEXI tags

STEXI and ETEXI is not used anymore since we switched to Sphinx. Replace them in the example with SRST and ERST, too.

---
 docs/devel/writing-monitor-commands.rst | 11 ++++-------
 1 file changed, 4 insertions(+), 7 deletions(-)
docs/devel/writing-monitor-commands.rst +4 -7
index 1693822f8f..4aa2bb904d 100644
@@ -331,13 +331,10 @@ we should add it to the hmp-commands.hx file::
         .cmd        = hmp_hello_world,
     },
 
-::
-
- STEXI
- @item hello_world @var{message}
- @findex hello_world
- Print message to the standard output
- ETEXI
+ SRST
+ ``hello_world`` *message*
+   Print message to the standard output
+ ERST
 
 To test this you have to open a user monitor and issue the "hello-world"
 command. It might be instructive to check the command's documentation with
Signature · 1 line
2.27.0
Reviewed-by on v1 1/1
#1 lore raw
Quoted 20 lines · Thomas Huth

STEXI and ETEXI is not used anymore since we switched to Sphinx. Replace them in the example with SRST and ERST, too.

---
 docs/devel/writing-monitor-commands.rst | 11 ++++-------
 1 file changed, 4 insertions(+), 7 deletions(-)
docs/devel/writing-monitor-commands.rst +0 -4
index 1693822f8f..4aa2bb904d 100644
@@ -331,13 +331,10 @@ we should add it to the hmp-commands.hx file::
         .cmd        = hmp_hello_world,
     },
 
-::
-
- STEXI
- @item hello_world @var{message}

docs/devel/writing-monitor-commands.rst we should add it to the hmp-commands.hx file:: · line 340

Quoted 10 lines
docs/devel/writing-monitor-commands.rst +4 -3
- @findex hello_world
- Print message to the standard output
- ETEXI
+ SRST
+ ``hello_world`` *message*
+   Print message to the standard output
+ ERST
 
 To test this you have to open a user monitor and issue the "hello-world"
 command. It might be instructive to check the command's documentation with