Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Jim Blandy <jimb@red-bean.com>
To: Andrew STUBBS <andrew.stubbs@st.com>
Cc: gdb-patches@sources.redhat.com
Subject: Re: [PATCH] init-if-undefined command
Date: Wed, 30 Nov 2005 13:59:00 -0000	[thread overview]
Message-ID: <8f2776cb0511292141t2f9711a2l9633236db737e67b@mail.gmail.com> (raw)
In-Reply-To: <437B3E56.3080306@st.com>

On 11/16/05, Andrew STUBBS <andrew.stubbs@st.com> wrote:
> +      printf_unfiltered ("usage: init-if-undefined $<var> = <expr>\n");

Provide a full English sentence here, not a traditional Unix "usage:" thingy.

> +      printf_unfiltered ("First parameter to init-if-undefined should be a GDB variable\n");

This should be a full sentence, with a preceding "The" and a period.

> +  add_com ("init-if-undefined", class_vars, init_if_undefined_command, _("\
> +init-if-undefined <var> = <expr>\n\
> +Ensure that an internal variable exists and set it to\n\
> +a given value if it does not."));

Use upper case for syntactic metavariables, like VAR and EXPR, not
<angle brackets>.  Refer to the metavariables in the doc string:
"Ensure that VAR ... and set it to the value of EXPR", etc.


  parent reply	other threads:[~2005-11-30  5:41 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2005-11-16 14:58 Andrew STUBBS
2005-11-16 20:00 ` Eli Zaretskii
2005-11-16 20:09   ` Joel Brobecker
2005-11-17  1:19     ` Jim Blandy
     [not found]     ` <8f2776cb0511161507j33208ae1k1e0753b72b992c73@mail.gmail.com>
     [not found]       ` <20051116233326.GZ1635@adacore.com>
     [not found]         ` <8f2776cb0511161602wb469964xdd904aab0d70d2a6@mail.gmail.com>
2005-11-17  3:45           ` Joel Brobecker
2005-11-17  4:47   ` Daniel Jacobowitz
2005-11-30  1:58 ` Andrew STUBBS
2005-11-30 13:59 ` Jim Blandy [this message]
2005-11-30 20:28   ` Andrew STUBBS
2005-11-30 21:20     ` Jim Blandy
2005-11-30 23:01     ` Daniel Jacobowitz
     [not found]       ` <8f2776cb0511301501t4eb7bb50w484427fd892f5a58@mail.gmail.com>
2005-12-01 11:55         ` Andrew STUBBS
2005-12-01 17:32           ` Andrew STUBBS
2005-12-01 23:38             ` Jim Blandy
2005-12-02 10:44               ` Andrew STUBBS
2005-12-02 10:33             ` Eli Zaretskii
2005-12-02 11:18               ` Andrew STUBBS
2005-12-01 22:50           ` Jim Blandy
2005-12-02 13:05             ` Andrew STUBBS

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=8f2776cb0511292141t2f9711a2l9633236db737e67b@mail.gmail.com \
    --to=jimb@red-bean.com \
    --cc=andrew.stubbs@st.com \
    --cc=gdb-patches@sources.redhat.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