Re: [PATCH 2/3] deprecate "skip enable/etc.", doc string cleanup

Pedro Alves
2016-04-18T20:32:12Z

On 04/18/2016 09:01 PM, Doug Evans wrote:
> On Mon, Apr 18, 2016 at 12:53 PM, Eli Zaretskii <eliz@gnu.org> wrote:
>>> From: Doug Evans <dje@google.com>
>>> Date: Mon, 18 Apr 2016 12:42:04 -0700
>>> Cc: gdb-patches <gdb-patches@sourceware.org>
>>>
>>> I certainly don't want to replicate all that text again
>>> and again (hence the macros).
>>
>> I understand, but put yourself in the position of someone who needs to
>> review a patch, and sees something like this:
>>
>> +Display the status of skips.\n"
>> +EDDI_USAGE_DOC_STRING_WITH_ALL ("skip", "info skip", "displayed")));
>>
>> How does that someone know if the resulting text is good English and
>> will produce a clear help text, or needs to be fixed in some way?
>
> I'm open to suggestions.
>
> I really hope the solution is to not expand all those macro
> invocations in place.
>

I think the answer is to include the before/after GDB output in
the mail submission / git log.

We actually already ask for that in the contribution checklist [1]:

"If you're changing the output of some command, include a paste of the
relevant parts of gdb session, before and after the change."

[1] - https://sourceware.org/gdb/wiki/ContributionChecklist#General_requirements

Thanks,
Pedro Alves