All of lore.kernel.org
 help / color / mirror / Atom feed
From: Markus Armbruster <armbru@redhat.com>
To: Thomas Huth <thuth@redhat.com>
Cc: "Peter Maydell" <peter.maydell@linaro.org>,
	qemu-devel@nongnu.org,
	"Dr . David Alan Gilbert" <dgilbert@redhat.com>,
	"Eric Blake" <eblake@redhat.com>,
	"Daniel P. Berrangé" <berrange@redhat.com>
Subject: Re: [PATCH] docs/devel/writing-monitor-commands: Replace obsolete STEXI/ETEXI tags
Date: Fri, 06 May 2022 19:17:38 +0200	[thread overview]
Message-ID: <871qx6h971.fsf@pond.sub.org> (raw)
In-Reply-To: <20220506150146.564244-1-thuth@redhat.com> (Thomas Huth's message of "Fri, 6 May 2022 17:01:46 +0200")

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>



      reply	other threads:[~2022-05-06 17:18 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-05-06 15:01 [PATCH] docs/devel/writing-monitor-commands: Replace obsolete STEXI/ETEXI tags Thomas Huth
2022-05-06 17:17 ` Markus Armbruster [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=871qx6h971.fsf@pond.sub.org \
    --to=armbru@redhat.com \
    --cc=berrange@redhat.com \
    --cc=dgilbert@redhat.com \
    --cc=eblake@redhat.com \
    --cc=peter.maydell@linaro.org \
    --cc=qemu-devel@nongnu.org \
    --cc=thuth@redhat.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.