[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH] docs/devel/writing-monitor-commands: Replace obsolete STEXI/
From: |
Markus Armbruster |
Subject: |
Re: [PATCH] docs/devel/writing-monitor-commands: Replace obsolete STEXI/ETEXI tags |
Date: |
Fri, 06 May 2022 19:17:38 +0200 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/27.2 (gnu/linux) |
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>