hmp-commands.hx: List abbreviation after command for cont, quit, print

[PATCH] hmp-commands.hx: List abbreviation after command for cont, quit, print

Posted by Peter Maydell 3 years, 5 months ago

We have four HMP commands which have a single-character abbreviated
version: cont ('c'), quit ('q'), print ('p') and help ('h').  For
cont, quit and print, we list the abbreviation first in the help
documentation and the command name.  This has the odd effect that in
the full 'help' command list these commands end up sorted out of
alphabetical order (they end up after all the other commands that
start with the same letter).  As it happens, the only place this
currently changes the order is for 'cont'.

Abbreviation first is also not a very logical order, and it doesn't
match what we use for 'help' (which is 'help|?').  Put the full
command name first in both the help text and the .name field for
cont, quit and print.

Fixes: https://bugs.launchpad.net/qemu/+bug/1614609
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
 hmp-commands.hx | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/hmp-commands.hx b/hmp-commands.hx
index ff2d7aa8f3e..15a14ed4c7f 100644
--- a/hmp-commands.hx
+++ b/hmp-commands.hx
@@ -40,7 +40,7 @@ SRST
 ERST
 
     {
-        .name       = "q|quit",
+        .name       = "quit|q",
         .args_type  = "",
         .params     = "",
         .help       = "quit the emulator",
@@ -48,7 +48,7 @@ ERST
     },
 
 SRST
-``q`` or ``quit``
+``quit`` or ``q``
   Quit the emulator.
 ERST
 
@@ -400,7 +400,7 @@ SRST
 ERST
 
     {
-        .name       = "c|cont",
+        .name       = "cont|c",
         .args_type  = "",
         .params     = "",
         .help       = "resume emulation",
@@ -408,7 +408,7 @@ ERST
     },
 
 SRST
-``c`` or ``cont``
+``cont`` or ``c``
   Resume emulation.
 ERST
 
@@ -553,7 +553,7 @@ SRST
 ERST
 
     {
-        .name       = "p|print",
+        .name       = "print|p",
         .args_type  = "fmt:/,val:l",
         .params     = "/fmt expr",
         .help       = "print expression value (use $reg for CPU register access)",
@@ -561,7 +561,7 @@ ERST
     },
 
 SRST
-``p`` or ``print/``\ *fmt* *expr*
+``print`` or ``p/``\ *fmt* *expr*
   Print expression value. Only the *format* part of *fmt* is
   used.
 ERST
-- 
2.20.1

Re: [PATCH] hmp-commands.hx: List abbreviation after command for cont, quit, print

Posted by Philippe Mathieu-Daudé 3 years, 5 months ago

On 11/21/20 4:17 PM, Peter Maydell wrote:
> We have four HMP commands which have a single-character abbreviated
> version: cont ('c'), quit ('q'), print ('p') and help ('h').  For
> cont, quit and print, we list the abbreviation first in the help
> documentation and the command name.  This has the odd effect that in
> the full 'help' command list these commands end up sorted out of
> alphabetical order (they end up after all the other commands that
> start with the same letter).  As it happens, the only place this
> currently changes the order is for 'cont'.
> 
> Abbreviation first is also not a very logical order, and it doesn't
> match what we use for 'help' (which is 'help|?').  Put the full
> command name first in both the help text and the .name field for
> cont, quit and print.
> 
> Fixes: https://bugs.launchpad.net/qemu/+bug/1614609
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
>  hmp-commands.hx | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)

Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>

Re: [PATCH] hmp-commands.hx: List abbreviation after command for cont, quit, print

Posted by Dr. David Alan Gilbert 3 years, 4 months ago

* Peter Maydell (peter.maydell@linaro.org) wrote:
> We have four HMP commands which have a single-character abbreviated
> version: cont ('c'), quit ('q'), print ('p') and help ('h').  For
> cont, quit and print, we list the abbreviation first in the help
> documentation and the command name.  This has the odd effect that in
> the full 'help' command list these commands end up sorted out of
> alphabetical order (they end up after all the other commands that
> start with the same letter).  As it happens, the only place this
> currently changes the order is for 'cont'.
> 
> Abbreviation first is also not a very logical order, and it doesn't
> match what we use for 'help' (which is 'help|?').  Put the full
> command name first in both the help text and the .name field for
> cont, quit and print.
> 
> Fixes: https://bugs.launchpad.net/qemu/+bug/1614609
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

Thanks; I like old bugs being fixed!


Reviewed-by: Dr. David Alan Gilbert <dgilbert@redhat.com>

> ---
>  hmp-commands.hx | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/hmp-commands.hx b/hmp-commands.hx
> index ff2d7aa8f3e..15a14ed4c7f 100644
> --- a/hmp-commands.hx
> +++ b/hmp-commands.hx
> @@ -40,7 +40,7 @@ SRST
>  ERST
>  
>      {
> -        .name       = "q|quit",
> +        .name       = "quit|q",
>          .args_type  = "",
>          .params     = "",
>          .help       = "quit the emulator",
> @@ -48,7 +48,7 @@ ERST
>      },
>  
>  SRST
> -``q`` or ``quit``
> +``quit`` or ``q``
>    Quit the emulator.
>  ERST
>  
> @@ -400,7 +400,7 @@ SRST
>  ERST
>  
>      {
> -        .name       = "c|cont",
> +        .name       = "cont|c",
>          .args_type  = "",
>          .params     = "",
>          .help       = "resume emulation",
> @@ -408,7 +408,7 @@ ERST
>      },
>  
>  SRST
> -``c`` or ``cont``
> +``cont`` or ``c``
>    Resume emulation.
>  ERST
>  
> @@ -553,7 +553,7 @@ SRST
>  ERST
>  
>      {
> -        .name       = "p|print",
> +        .name       = "print|p",
>          .args_type  = "fmt:/,val:l",
>          .params     = "/fmt expr",
>          .help       = "print expression value (use $reg for CPU register access)",
> @@ -561,7 +561,7 @@ ERST
>      },
>  
>  SRST
> -``p`` or ``print/``\ *fmt* *expr*
> +``print`` or ``p/``\ *fmt* *expr*
>    Print expression value. Only the *format* part of *fmt* is
>    used.
>  ERST
> -- 
> 2.20.1
> 
-- 
Dr. David Alan Gilbert / dgilbert@redhat.com / Manchester, UK

Re: [PATCH] hmp-commands.hx: List abbreviation after command for cont, quit, print

Posted by Dr. David Alan Gilbert 3 years, 4 months ago

* Peter Maydell (peter.maydell@linaro.org) wrote:
> We have four HMP commands which have a single-character abbreviated
> version: cont ('c'), quit ('q'), print ('p') and help ('h').  For
> cont, quit and print, we list the abbreviation first in the help
> documentation and the command name.  This has the odd effect that in
> the full 'help' command list these commands end up sorted out of
> alphabetical order (they end up after all the other commands that
> start with the same letter).  As it happens, the only place this
> currently changes the order is for 'cont'.
> 
> Abbreviation first is also not a very logical order, and it doesn't
> match what we use for 'help' (which is 'help|?').  Put the full
> command name first in both the help text and the .name field for
> cont, quit and print.
> 
> Fixes: https://bugs.launchpad.net/qemu/+bug/1614609
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>

Queued

> ---
>  hmp-commands.hx | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/hmp-commands.hx b/hmp-commands.hx
> index ff2d7aa8f3e..15a14ed4c7f 100644
> --- a/hmp-commands.hx
> +++ b/hmp-commands.hx
> @@ -40,7 +40,7 @@ SRST
>  ERST
>  
>      {
> -        .name       = "q|quit",
> +        .name       = "quit|q",
>          .args_type  = "",
>          .params     = "",
>          .help       = "quit the emulator",
> @@ -48,7 +48,7 @@ ERST
>      },
>  
>  SRST
> -``q`` or ``quit``
> +``quit`` or ``q``
>    Quit the emulator.
>  ERST
>  
> @@ -400,7 +400,7 @@ SRST
>  ERST
>  
>      {
> -        .name       = "c|cont",
> +        .name       = "cont|c",
>          .args_type  = "",
>          .params     = "",
>          .help       = "resume emulation",
> @@ -408,7 +408,7 @@ ERST
>      },
>  
>  SRST
> -``c`` or ``cont``
> +``cont`` or ``c``
>    Resume emulation.
>  ERST
>  
> @@ -553,7 +553,7 @@ SRST
>  ERST
>  
>      {
> -        .name       = "p|print",
> +        .name       = "print|p",
>          .args_type  = "fmt:/,val:l",
>          .params     = "/fmt expr",
>          .help       = "print expression value (use $reg for CPU register access)",
> @@ -561,7 +561,7 @@ ERST
>      },
>  
>  SRST
> -``p`` or ``print/``\ *fmt* *expr*
> +``print`` or ``p/``\ *fmt* *expr*
>    Print expression value. Only the *format* part of *fmt* is
>    used.
>  ERST
> -- 
> 2.20.1
> 
> 
-- 
Dr. David Alan Gilbert / dgilbert@redhat.com / Manchester, UK