From: Emily Shaffer <email@example.com>
To: Elijah Newren <firstname.lastname@example.org>
Cc: Git Mailing List <email@example.com>
Subject: Re: [PATCH v2] doc: hint about GIT_DEBUGGER
Date: Tue, 21 May 2019 11:19:43 -0700 [thread overview]
Message-ID: <20190521181943.GA82620@google.com> (raw)
On Tue, May 21, 2019 at 09:06:18AM -0700, Elijah Newren wrote:
> On Mon, May 20, 2019 at 6:01 PM Emily Shaffer <firstname.lastname@example.org> wrote:
> > We check for a handy environment variable GIT_DEBUGGER when running via
> > bin-wrappers/, but this feature is undocumented. Add a hint to how to
> > use it into the CodingGuidelines (which is where other useful
> > environment settings like DEVELOPER are documented).
> Two very minor nits:
> > It looks like you can use GIT_DEBUGGER to pick gdb by default, or you
> I think it'd sound better without 'It looks like'; perhaps drop that part?
> > can hand it your own debugger if you like to use something else (or if
> > you want custom flags for gdb). Hopefully document that intent within
> > CodingGuidelines.
> Maybe just leave out 'Hopefully'?
> > Signed-off-by: Emily Shaffer <email@example.com>
> > ---
> > Documentation/CodingGuidelines | 6 ++++++
> > 1 file changed, 6 insertions(+)
> > diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
> > index 32210a4386..e99af36df9 100644
> > --- a/Documentation/CodingGuidelines
> > +++ b/Documentation/CodingGuidelines
> > @@ -412,6 +412,12 @@ For C programs:
> > must be declared with "extern" in header files. However, function
> > declarations should not use "extern", as that is already the default.
> > + - You can launch gdb around your program using the shorthand GIT_DEBUGGER.
> > + Run `GIT_DEBUGGER=1 ./bin-wrappers/git foo` to simply use gdb as is, or
> > + run `GIT_DEBUGGER=my-debugger-binary my-args ./bin-wrappers/git foo` to
> > + use your own debugger and arguments. Example: `GIT_DEBUGGER="ddd --gdb"
> > + ./bin-wrappers/git log` (See `wrap-for-bin.sh`.)
> > +
> Other than the minor nits above:
> Acked-by: Elijah Newren <firstname.lastname@example.org>
Made both the changes you recommended; I'll hang onto it locally until
this afternoon in case anybody else has something to say. Thanks for
next prev parent reply other threads:[~2019-05-21 18:19 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-05-17 20:48 [PATCH] doc: hint about GIT_DEBUGGER Emily Shaffer
2019-05-18 5:40 ` Elijah Newren
2019-05-20 20:38 ` Emily Shaffer
2019-05-21 1:00 ` [PATCH v2] " Emily Shaffer
2019-05-21 16:06 ` Elijah Newren
2019-05-21 18:19 ` Emily Shaffer [this message]
2019-05-23 0:55 ` [PATCH v3] doc: hint about GIT_DEBUGGER in CodingGuidelines Emily Shaffer
2019-05-23 10:09 ` Eric Sunshine
2019-05-28 19:05 ` Emily Shaffer
2019-05-28 19:07 ` [PATCH v4] " Emily Shaffer
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:
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
* 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.
Code repositories for project(s) associated with this public inbox
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).