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

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

Posted by Thomas Huth 2 years ago

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

Signed-off-by: Thomas Huth <thuth@redhat.com>
---
 docs/devel/writing-monitor-commands.rst | 11 ++++-------
 1 file changed, 4 insertions(+), 7 deletions(-)

diff --git a/docs/devel/writing-monitor-commands.rst b/docs/devel/writing-monitor-commands.rst
index 1693822f8f..4aa2bb904d 100644
--- a/docs/devel/writing-monitor-commands.rst
+++ b/docs/devel/writing-monitor-commands.rst
@@ -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
-- 
2.27.0

Re: [PATCH] docs/devel/writing-monitor-commands: Replace obsolete STEXI/ETEXI tags

Posted by Markus Armbruster 2 years ago

Thomas Huth <thuth@redhat.com> writes:

> STEXI and ETEXI is not used anymore since we switched to Sphinx.
> Replace them in the example with SRST and ERST, too.
>
> Signed-off-by: Thomas Huth <thuth@redhat.com>
> ---
>  docs/devel/writing-monitor-commands.rst | 11 ++++-------
>  1 file changed, 4 insertions(+), 7 deletions(-)
>
> diff --git a/docs/devel/writing-monitor-commands.rst b/docs/devel/writing-monitor-commands.rst
> index 1693822f8f..4aa2bb904d 100644
> --- a/docs/devel/writing-monitor-commands.rst
> +++ b/docs/devel/writing-monitor-commands.rst
> @@ -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

Reviewed-by: Markus Armbruster <armbru@redhat.com>