Re: [PATCH] init-if-undefined command

Jim Blandy
2005-11-30T05:41:51Z

On 11/16/05, Andrew STUBBS <andrew.stubbs@st.com> wrote:
> + printf_unfiltered ("usage: init-if-undefined $ = <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 = <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.