Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Doug Evans <dje@google.com>
Cc: gdb-patches@sourceware.org
Subject: Re: [PATCH 2/3] deprecate "skip enable/etc.", doc string cleanup
Date: Tue, 19 Apr 2016 02:33:00 -0000	[thread overview]
Message-ID: <83oa968gzx.fsf@gnu.org> (raw)
In-Reply-To: <CADPb22SQeyD9FZ9yRHiCEK=u4VsfsGiu-rNKJr9yyf3ecj1YZA@mail.gmail.com>	(message from Doug Evans on Mon, 18 Apr 2016 13:01:37 -0700)

> From: Doug Evans <dje@google.com>
> Date: Mon, 18 Apr 2016 13:01:37 -0700
> Cc: gdb-patches <gdb-patches@sourceware.org>
> 
> 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.

If I'm the only one who is bothered by such macro-izing of doc
strings, then just ignore me.


      parent reply	other threads:[~2016-04-19  2:33 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-04-18 15:47 Doug Evans
2016-04-18 18:57 ` Eli Zaretskii
2016-04-18 19:42   ` Doug Evans
2016-04-18 19:53     ` Eli Zaretskii
2016-04-18 20:02       ` Doug Evans
2016-04-18 20:32         ` Pedro Alves
2016-04-19  2:33         ` Eli Zaretskii [this message]

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=83oa968gzx.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=dje@google.com \
    --cc=gdb-patches@sourceware.org \
    /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