Re: [Qemu-devel] [PATCH] qemu-doc: Do not hard-code the name of the QEMU binary

[Peter Maydell]

On Wed, 28 Aug 2019 at 10:37, Thomas Huth <address@hidden> wrote:
>
> In our documentation, we use a mix of "$QEMU", "qemu-system-i386" and
> "qemu-system-x86_64" when we give examples to the users how to run
> QEMU. Some more consistency would be good here. Also some distributions
> use different names for the QEMU binary (e.g. "qemu-kvm" in RHEL), so
> providing more flexibility here would also be good. Thus let's define
> some variables for the names of the QEMU command and use those in the
> documentation instead: @value{qemu_system} for generic examples, and
> @value{qemu_system_x86} for examples that only work with the x86
> binaries.
>
> Signed-off-by: Thomas Huth <address@hidden>
> ---
>  docs/qemu-block-drivers.texi |  72 ++++++++++----------
>  docs/qemu-cpu-models.texi    |  10 +--
>  qemu-doc.texi                |  81 +++++++++++-----------
>  qemu-options.hx              | 128 +++++++++++++++++------------------
>  4 files changed, 149 insertions(+), 142 deletions(-)
>
> diff --git a/docs/qemu-block-drivers.texi b/docs/qemu-block-drivers.texi
> index c02547e28c..2c7ea49c32 100644
> --- a/docs/qemu-block-drivers.texi
> +++ b/docs/qemu-block-drivers.texi
> @@ -2,6 +2,8 @@
>  QEMU block driver reference manual
>  @c man end
>
> +@set qemu_system qemu-system-x86_64
> +
>  @c man begin DESCRIPTION
>
>  @node disk_images_formats
> @@ -405,7 +407,7 @@ QEMU can automatically create a virtual FAT disk image 
> from a
>  directory tree. In order to use it, just type:
>
>  @example
> -qemu-system-i386 linux.img -hdb fat:/my_directory
> +@value{qemu_system} linux.img -hdb fat:/my_directory
>  @end example

Do you use the ability to change the text being substituted
here downstream ? If so, heads-up that I'm working on a
conversion of this texi file to rst. I'll put in a
similar rst substitution-reference, which will look like
this:

.. |qemu_system| replace:: qemu-system-x86_64

but you'll need to update your downstream processes if
you're changing the value in the texi currently.

thanks
-- PMM