public inbox for gdb-patches@sourceware.org
 help / color / mirror / Atom feed
From: Pedro Alves <palves@redhat.com>
To: Tom Tromey <tom@tromey.com>, gdb-patches@sourceware.org
Subject: Re: [RFA 04/12] Update memattr.c help strings
Date: Fri, 04 May 2018 18:16:00 -0000	[thread overview]
Message-ID: <4ac45e86-d5c0-6f97-a72c-d6f0f79a3e26@redhat.com> (raw)
In-Reply-To: <20180430143731.30007-5-tom@tromey.com>

On 04/30/2018 03:37 PM, Tom Tromey wrote:
> This changes memattr.c to use the GNU style for help strings.
> 
> 2018-04-29  Tom Tromey  <tom@tromey.com>
> 
> 	* memattr.c (_initialize_mem): Update help string.
> ---
>  gdb/ChangeLog |  4 ++++
>  gdb/memattr.c | 14 +++++++-------
>  2 files changed, 11 insertions(+), 7 deletions(-)
> 
> diff --git a/gdb/memattr.c b/gdb/memattr.c
> index 8dad38b039..328a63a19d 100644
> --- a/gdb/memattr.c
> +++ b/gdb/memattr.c
> @@ -603,27 +603,27 @@ _initialize_mem (void)
>  Define attributes for memory region or reset memory region handling to\n\
>  target-based.\n\
>  Usage: mem auto\n\
> -       mem <lo addr> <hi addr> [<mode> <width> <cache>],\n\
> -where <mode>  may be rw (read/write), ro (read-only) or wo (write-only),\n\
> -      <width> may be 8, 16, 32, or 64, and\n\
> -      <cache> may be cache or nocache"));
> +       mem LOW HIGH [MODE WIDTH CACHE],\n\
> +where MODE  may be rw (read/write), ro (read-only) or wo (write-only),\n\
> +      WIDTH may be 8, 16, 32, or 64, and\n\
> +      CACHE may be cache or nocache"));
>  
>    add_cmd ("mem", class_vars, enable_mem_command, _("\
>  Enable memory region.\n\
>  Arguments are the code numbers of the memory regions to enable.\n\
> -Usage: enable mem <code number>...\n\
> +Usage: enable mem [CODE]...\n\
>  Do \"info mem\" to see current list of code numbers."), &enablelist);
>  
>    add_cmd ("mem", class_vars, disable_mem_command, _("\
>  Disable memory region.\n\
>  Arguments are the code numbers of the memory regions to disable.\n\
> -Usage: disable mem <code number>...\n\
> +Usage: disable mem [CODE]...\n\
>  Do \"info mem\" to see current list of code numbers."), &disablelist);
>  
>    add_cmd ("mem", class_vars, delete_mem_command, _("\
>  Delete memory region.\n\
>  Arguments are the code numbers of the memory regions to delete.\n\
> -Usage: delete mem <code number>...\n\
> +Usage: delete mem [CODE]...\n\
>  Do \"info mem\" to see current list of code numbers."), &deletelist);
>  

I was surprised and confused with the references to "code" and
"code numbers" here.  These are just the numbers as displayed
in the first column of "info mem", right?  How about changing
the references to "code numbers" and "CODE" above to 
numbers or IDs?  The manuals uses "nums".

Thanks,
Pedro Alves

  reply	other threads:[~2018-05-04 18:16 UTC|newest]

Thread overview: 34+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-04-30 14:37 [RFA 00/12] Small help text tweaks Tom Tromey
2018-04-30 14:37 ` [RFA 10/12] Update help text in record-btrace.c Tom Tromey
2018-05-04 18:55   ` Pedro Alves
2018-04-30 14:37 ` [RFA 07/12] Update help text for "jump" command Tom Tromey
2018-05-04 18:52   ` Pedro Alves
2018-04-30 14:37 ` [RFA 05/12] Update help strings in TUI Tom Tromey
2018-05-04 18:26   ` Pedro Alves
2018-04-30 14:37 ` [RFA 03/12] Update core-related help strings Tom Tromey
2018-05-04 18:11   ` Pedro Alves
2018-05-09 20:31     ` Tom Tromey
2018-05-24 21:28       ` Pedro Alves
2018-04-30 14:37 ` [RFA 01/12] Fix help and documentation for inferior commands Tom Tromey
2018-04-30 15:26   ` Eli Zaretskii
2018-05-04 18:07     ` Pedro Alves
2018-05-09 20:29     ` Tom Tromey
2018-05-10  9:17       ` Eli Zaretskii
2018-04-30 14:37 ` [RFA 04/12] Update memattr.c help strings Tom Tromey
2018-05-04 18:16   ` Pedro Alves [this message]
2018-05-09 20:35     ` Tom Tromey
2018-05-24 17:53       ` Pedro Alves
2018-04-30 14:37 ` [RFA 11/12] Update help text in linux-fork.c Tom Tromey
2018-05-04 18:56   ` Pedro Alves
2018-04-30 14:37 ` [RFA 06/12] Update help text in dcache.c Tom Tromey
2018-05-04 18:27   ` Pedro Alves
2018-04-30 14:37 ` [RFA 02/12] Update help strings in skip.c Tom Tromey
2018-05-04 18:09   ` Pedro Alves
2018-04-30 14:37 ` [RFA 12/12] Update help text in record.c Tom Tromey
2018-05-04 18:57   ` Pedro Alves
2018-04-30 14:37 ` [RFA 08/12] Update help text in disasm.c Tom Tromey
2018-05-04 18:54   ` Pedro Alves
2018-04-30 14:37 ` [RFA 09/12] Update help text in tracepoint.c Tom Tromey
2018-05-04 18:54   ` Pedro Alves
2018-04-30 14:40 ` [RFA 00/12] Small help text tweaks Eli Zaretskii
2018-04-30 15:13   ` Tom Tromey

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=4ac45e86-d5c0-6f97-a72c-d6f0f79a3e26@redhat.com \
    --to=palves@redhat.com \
    --cc=gdb-patches@sourceware.org \
    --cc=tom@tromey.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).