diff mbox series

[5/5] qemu-img-cmds.hx: add passive-aggressive note

Message ID 20180503225648.13153-6-jsnow@redhat.com
State New
Headers show
Series qemu-img: make subcommand usage docstrings consistent | expand

Commit Message

John Snow May 3, 2018, 10:56 p.m. UTC
I'm kidding. It's very easy to forget there are per-command sections
in the texi, and insane that we don't autogenerate those, too.

Until then, leave a little post-it note in this .hx file until I
find a way to delete it.

Signed-off-by: John Snow <jsnow@redhat.com>
---
 qemu-img-cmds.hx | 3 +++
 1 file changed, 3 insertions(+)

Comments

Jeff Cody May 8, 2018, 3:49 p.m. UTC | #1
On Thu, May 03, 2018 at 06:56:48PM -0400, John Snow wrote:
> I'm kidding. It's very easy to forget there are per-command sections
> in the texi, and insane that we don't autogenerate those, too.
> 
> Until then, leave a little post-it note in this .hx file until I
> find a way to delete it.
>

Hopefully helps, but as you said the real fix is autogeneration.

Reviewed-by: Jeff Cody <jcody@redhat.com>

> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
>  qemu-img-cmds.hx | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/qemu-img-cmds.hx b/qemu-img-cmds.hx
> index 84deb858af..3d2f7b26eb 100644
> --- a/qemu-img-cmds.hx
> +++ b/qemu-img-cmds.hx
> @@ -6,6 +6,9 @@ HXCOMM DEF(command, callback, arg_string) is used to construct
>  HXCOMM command structures and help message.
>  HXCOMM HXCOMM can be used for comments, discarded from both texi and C
>  
> +HXCOMM When amending the TEXI sections, please remember to copy the usage
> +HXCOMM over to the per-command sections in qemu-img.texi.
> +
>  STEXI
>  @table @option
>  ETEXI
> -- 
> 2.14.3
> 
>
diff mbox series

Patch

diff --git a/qemu-img-cmds.hx b/qemu-img-cmds.hx
index 84deb858af..3d2f7b26eb 100644
--- a/qemu-img-cmds.hx
+++ b/qemu-img-cmds.hx
@@ -6,6 +6,9 @@  HXCOMM DEF(command, callback, arg_string) is used to construct
 HXCOMM command structures and help message.
 HXCOMM HXCOMM can be used for comments, discarded from both texi and C
 
+HXCOMM When amending the TEXI sections, please remember to copy the usage
+HXCOMM over to the per-command sections in qemu-img.texi.
+
 STEXI
 @table @option
 ETEXI