Re: [Qemu-devel] [PATCH v2 1/2] HMP: fix doc of dump-guest-memory

[Markus Armbruster]

Qiao Nuohan <address@hidden> writes:

> Signed-off-by: Qiao Nuohan <address@hidden>
> ---
>  hmp-commands.hx | 19 ++++++++++---------
>  1 file changed, 10 insertions(+), 9 deletions(-)
>
> diff --git a/hmp-commands.hx b/hmp-commands.hx
> index f3fc514..c242770 100644
> --- a/hmp-commands.hx
> +++ b/hmp-commands.hx
> @@ -999,25 +999,26 @@ ETEXI
>      {
>          .name       = "dump-guest-memory",
>          .args_type  = "paging:-p,filename:F,begin:i?,length:i?",
> -        .params     = "[-p] filename [begin] [length]",
> -        .help       = "dump guest memory to file"
> -                      "\n\t\t\t begin(optional): the starting physical 
> address"
> -                      "\n\t\t\t length(optional): the memory size, in bytes",
> +        .params     = "[-p] filename [begin length]",
> +        .help       = "dump guest memory into file 'filename'.\n\t\t\t"
> +                      "-p: do paging to get guest's memory mapping.\n\t\t\t"
> +                      "begin: the starting physical address.\n\t\t\t"
> +                      "length: the memory size, in bytes.",
>          .mhandler.cmd = hmp_dump_guest_memory,
>      },
>  
>  
>  STEXI
> address@hidden dump-guest-memory [-p] @var{protocol} @var{begin} @var{length}
> address@hidden dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
>  @findex dump-guest-memory
>  Dump guest memory to @var{protocol}. The file can be processed with crash or
>  gdb.
> -  filename: dump file name
> -    paging: do paging to get guest's memory mapping
> +        -p: do paging to get guest's memory mapping.
> +  filename: dump file name.
>       begin: the starting physical address. It's optional, and should be
> -            specified with length together.
> +            specified together with length.
>      length: the memory size, in bytes. It's optional, and should be specified
> -            with begin together.
> +            together with begin.
>  ETEXI
>  
>      {

I wouldn't add periods here.

Have you considered describing the "if you specify begin, you have to
specify length, too" more compactly?  Like this:

@item dump-guest-memory [-p] @var{filename} address@hidden @var{length}]
@findex dump-guest-memory
Dump guest memory to @var{protocol}. The file can be processed with crash or
gdb.
        -p: do paging to get guest's memory mapping.
  filename: dump file name
     begin: the starting physical address
    length: the memory size, in bytes
ETEXI