1. Patchew
  2. QEMU
  3. [Qemu-devel] [PATCH 0/8] qemu-options: Texinfo and --help fixes
  4. View patch

[Qemu-devel] [PATCH 1/8] qemu-options: Remove stray colons from output of --help

Markus Armbruster posted 8 patches 8 years, 4 months ago
[Qemu-devel] [PATCH 1/8] qemu-options: Remove stray colons from output of --help
Posted by Markus Armbruster 8 years, 4 months ago 
Commit 43f187a broke --help: it put colons into blank lines.  It
removed the colon from DEFHEADING(TITLE:) and added it back in the
macro expansion of DEFHEADING(TITLE), so hxtool can emit "@subsection
TITLE" more easily.  Trouble is it's added back even for the blank
lines made with DEFHEADING().

Put the colons back where they were before commit 43f187a, and strip
them in hxtool instead.

Cc: Paolo Bonzini <pbonzini@redhat.com>
CC: qemu-stable@nongnu.org
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 qemu-options-wrapper.h |  2 +-
 qemu-options.hx        | 27 ++++++++++++++-------------
 scripts/hxtool         |  3 ++-
 3 files changed, 17 insertions(+), 15 deletions(-)

diff --git a/qemu-options-wrapper.h b/qemu-options-wrapper.h
index 4d7aeb1352..13bfea0294 100644
--- a/qemu-options-wrapper.h
+++ b/qemu-options-wrapper.h
@@ -14,7 +14,7 @@
 
 #define ARCHHEADING(text, arch_mask) \
     if ((arch_mask) & arch_type)    \
-        puts(stringify(text) ":");
+        puts(stringify(text));
 
 #define DEFHEADING(text) ARCHHEADING(text, QEMU_ARCH_ALL)
 
diff --git a/qemu-options.hx b/qemu-options.hx
index 39225ae6c3..0fed2fc009 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -6,7 +6,7 @@ HXCOMM construct option structures, enums and help message for specified
 HXCOMM architectures.
 HXCOMM HXCOMM can be used for comments, discarded from both texi and C
 
-DEFHEADING(Standard options)
+DEFHEADING(Standard options:)
 STEXI
 @table @option
 ETEXI
@@ -578,7 +578,7 @@ STEXI
 ETEXI
 DEFHEADING()
 
-DEFHEADING(Block device options)
+DEFHEADING(Block device options:)
 STEXI
 @table @option
 ETEXI
@@ -1177,7 +1177,7 @@ STEXI
 ETEXI
 DEFHEADING()
 
-DEFHEADING(USB options)
+DEFHEADING(USB options:)
 STEXI
 @table @option
 ETEXI
@@ -1242,7 +1242,7 @@ STEXI
 ETEXI
 DEFHEADING()
 
-DEFHEADING(Display options)
+DEFHEADING(Display options:)
 STEXI
 @table @option
 ETEXI
@@ -1779,7 +1779,7 @@ STEXI
 ETEXI
 ARCHHEADING(, QEMU_ARCH_I386)
 
-ARCHHEADING(i386 target only, QEMU_ARCH_I386)
+ARCHHEADING(i386 target only:, QEMU_ARCH_I386)
 STEXI
 @table @option
 ETEXI
@@ -1895,7 +1895,7 @@ STEXI
 ETEXI
 DEFHEADING()
 
-DEFHEADING(Network options)
+DEFHEADING(Network options:)
 STEXI
 @table @option
 ETEXI
@@ -2476,7 +2476,7 @@ STEXI
 ETEXI
 DEFHEADING()
 
-DEFHEADING(Character device options)
+DEFHEADING(Character device options:)
 STEXI
 
 The general form of a character device option is:
@@ -2809,7 +2809,7 @@ STEXI
 ETEXI
 DEFHEADING()
 
-DEFHEADING(Device URL Syntax)
+DEFHEADING(Device URL Syntax:)
 STEXI
 
 In addition to using normal file images for the emulated storage devices,
@@ -3039,7 +3039,7 @@ STEXI
 @end table
 ETEXI
 
-DEFHEADING(Bluetooth(R) options)
+DEFHEADING(Bluetooth(R) options:)
 STEXI
 @table @option
 ETEXI
@@ -3115,7 +3115,7 @@ ETEXI
 DEFHEADING()
 
 #ifdef CONFIG_TPM
-DEFHEADING(TPM device options)
+DEFHEADING(TPM device options:)
 
 DEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \
     "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n"
@@ -3189,7 +3189,7 @@ DEFHEADING()
 
 #endif
 
-DEFHEADING(Linux/Multiboot boot specific)
+DEFHEADING(Linux/Multiboot boot specific:)
 STEXI
 
 When using these options, you can use a given Linux or Multiboot
@@ -3245,7 +3245,7 @@ STEXI
 ETEXI
 DEFHEADING()
 
-DEFHEADING(Debug/Expert options)
+DEFHEADING(Debug/Expert options:)
 STEXI
 @table @option
 ETEXI
@@ -4160,7 +4160,8 @@ STEXI
 @end table
 ETEXI
 DEFHEADING()
-DEFHEADING(Generic object creation)
+
+DEFHEADING(Generic object creation:)
 STEXI
 @table @option
 ETEXI
diff --git a/scripts/hxtool b/scripts/hxtool
index 1e2c97c5e6..7d7c4289e3 100644
--- a/scripts/hxtool
+++ b/scripts/hxtool
@@ -19,7 +19,8 @@ hxtoh()
 print_texi_heading()
 {
     if test "$*" != ""; then
-        printf "@subsection %s\n" "$*"
+        title="$*"
+        printf "@subsection %s\n" "${title%:}"
     fi
 }
 
-- 
2.13.6
Re: [Qemu-devel] [PATCH 1/8] qemu-options: Remove stray colons from output of --help
Posted by Eric Blake 8 years, 4 months ago 
On 10/02/2017 09:03 AM, Markus Armbruster wrote:
> Commit 43f187a broke --help: it put colons into blank lines.  It
> removed the colon from DEFHEADING(TITLE:) and added it back in the
> macro expansion of DEFHEADING(TITLE), so hxtool can emit "@subsection
> TITLE" more easily.  Trouble is it's added back even for the blank
> lines made with DEFHEADING().
> 
> Put the colons back where they were before commit 43f187a, and strip
> them in hxtool instead.
> 
> Cc: Paolo Bonzini <pbonzini@redhat.com>
> CC: qemu-stable@nongnu.org
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  qemu-options-wrapper.h |  2 +-
>  qemu-options.hx        | 27 ++++++++++++++-------------
>  scripts/hxtool         |  3 ++-
>  3 files changed, 17 insertions(+), 15 deletions(-)

Reviewed-by: Eric Blake <eblake@redhat.com>

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3266
Virtualization:  qemu.org | libvirt.org
Re: [Qemu-devel] [PATCH 1/8] qemu-options: Remove stray colons from output of --help
Posted by Marc-André Lureau 8 years, 4 months ago 
On Mon, Oct 2, 2017 at 4:03 PM, Markus Armbruster <armbru@redhat.com> wrote:
> Commit 43f187a broke --help: it put colons into blank lines.  It
> removed the colon from DEFHEADING(TITLE:) and added it back in the
> macro expansion of DEFHEADING(TITLE), so hxtool can emit "@subsection
> TITLE" more easily.  Trouble is it's added back even for the blank
> lines made with DEFHEADING().
>
> Put the colons back where they were before commit 43f187a, and strip
> them in hxtool instead.
>
> Cc: Paolo Bonzini <pbonzini@redhat.com>
> CC: qemu-stable@nongnu.org
> Signed-off-by: Markus Armbruster <armbru@redhat.com>

Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>


> ---
>  qemu-options-wrapper.h |  2 +-
>  qemu-options.hx        | 27 ++++++++++++++-------------
>  scripts/hxtool         |  3 ++-
>  3 files changed, 17 insertions(+), 15 deletions(-)
>
> diff --git a/qemu-options-wrapper.h b/qemu-options-wrapper.h
> index 4d7aeb1352..13bfea0294 100644
> --- a/qemu-options-wrapper.h
> +++ b/qemu-options-wrapper.h
> @@ -14,7 +14,7 @@
>
>  #define ARCHHEADING(text, arch_mask) \
>      if ((arch_mask) & arch_type)    \
> -        puts(stringify(text) ":");
> +        puts(stringify(text));
>
>  #define DEFHEADING(text) ARCHHEADING(text, QEMU_ARCH_ALL)
>
> diff --git a/qemu-options.hx b/qemu-options.hx
> index 39225ae6c3..0fed2fc009 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -6,7 +6,7 @@ HXCOMM construct option structures, enums and help message for specified
>  HXCOMM architectures.
>  HXCOMM HXCOMM can be used for comments, discarded from both texi and C
>
> -DEFHEADING(Standard options)
> +DEFHEADING(Standard options:)
>  STEXI
>  @table @option
>  ETEXI
> @@ -578,7 +578,7 @@ STEXI
>  ETEXI
>  DEFHEADING()
>
> -DEFHEADING(Block device options)
> +DEFHEADING(Block device options:)
>  STEXI
>  @table @option
>  ETEXI
> @@ -1177,7 +1177,7 @@ STEXI
>  ETEXI
>  DEFHEADING()
>
> -DEFHEADING(USB options)
> +DEFHEADING(USB options:)
>  STEXI
>  @table @option
>  ETEXI
> @@ -1242,7 +1242,7 @@ STEXI
>  ETEXI
>  DEFHEADING()
>
> -DEFHEADING(Display options)
> +DEFHEADING(Display options:)
>  STEXI
>  @table @option
>  ETEXI
> @@ -1779,7 +1779,7 @@ STEXI
>  ETEXI
>  ARCHHEADING(, QEMU_ARCH_I386)
>
> -ARCHHEADING(i386 target only, QEMU_ARCH_I386)
> +ARCHHEADING(i386 target only:, QEMU_ARCH_I386)
>  STEXI
>  @table @option
>  ETEXI
> @@ -1895,7 +1895,7 @@ STEXI
>  ETEXI
>  DEFHEADING()
>
> -DEFHEADING(Network options)
> +DEFHEADING(Network options:)
>  STEXI
>  @table @option
>  ETEXI
> @@ -2476,7 +2476,7 @@ STEXI
>  ETEXI
>  DEFHEADING()
>
> -DEFHEADING(Character device options)
> +DEFHEADING(Character device options:)
>  STEXI
>
>  The general form of a character device option is:
> @@ -2809,7 +2809,7 @@ STEXI
>  ETEXI
>  DEFHEADING()
>
> -DEFHEADING(Device URL Syntax)
> +DEFHEADING(Device URL Syntax:)
>  STEXI
>
>  In addition to using normal file images for the emulated storage devices,
> @@ -3039,7 +3039,7 @@ STEXI
>  @end table
>  ETEXI
>
> -DEFHEADING(Bluetooth(R) options)
> +DEFHEADING(Bluetooth(R) options:)
>  STEXI
>  @table @option
>  ETEXI
> @@ -3115,7 +3115,7 @@ ETEXI
>  DEFHEADING()
>
>  #ifdef CONFIG_TPM
> -DEFHEADING(TPM device options)
> +DEFHEADING(TPM device options:)
>
>  DEF("tpmdev", HAS_ARG, QEMU_OPTION_tpmdev, \
>      "-tpmdev passthrough,id=id[,path=path][,cancel-path=path]\n"
> @@ -3189,7 +3189,7 @@ DEFHEADING()
>
>  #endif
>
> -DEFHEADING(Linux/Multiboot boot specific)
> +DEFHEADING(Linux/Multiboot boot specific:)
>  STEXI
>
>  When using these options, you can use a given Linux or Multiboot
> @@ -3245,7 +3245,7 @@ STEXI
>  ETEXI
>  DEFHEADING()
>
> -DEFHEADING(Debug/Expert options)
> +DEFHEADING(Debug/Expert options:)
>  STEXI
>  @table @option
>  ETEXI
> @@ -4160,7 +4160,8 @@ STEXI
>  @end table
>  ETEXI
>  DEFHEADING()
> -DEFHEADING(Generic object creation)
> +
> +DEFHEADING(Generic object creation:)
>  STEXI
>  @table @option
>  ETEXI
> diff --git a/scripts/hxtool b/scripts/hxtool
> index 1e2c97c5e6..7d7c4289e3 100644
> --- a/scripts/hxtool
> +++ b/scripts/hxtool
> @@ -19,7 +19,8 @@ hxtoh()
>  print_texi_heading()
>  {
>      if test "$*" != ""; then
> -        printf "@subsection %s\n" "$*"
> +        title="$*"
> +        printf "@subsection %s\n" "${title%:}"
>      fi
>  }
>
> --
> 2.13.6
>
>



-- 
Marc-André Lureau

Patchew 2.1-devel-b67e4c2

© 2016 - 2026 Red Hat, Inc.