From: Emily Shaffer <email@example.com> To: Eric Sunshine <firstname.lastname@example.org> Cc: Git List <email@example.com>, Elijah Newren <firstname.lastname@example.org> Subject: Re: [PATCH v3] doc: hint about GIT_DEBUGGER in CodingGuidelines Date: Tue, 28 May 2019 12:05:10 -0700 [thread overview] Message-ID: <20190528190510.GA133078@google.com> (raw) In-Reply-To: <CAPig+cQSp2pY9_fYhDPO+YwEmVXiqB+wjhL9NTcA+Mc_TQbWHg@mail.gmail.com> On Thu, May 23, 2019 at 06:09:17AM -0400, Eric Sunshine wrote: > On Wed, May 22, 2019 at 8:56 PM Emily Shaffer <email@example.com> 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). > > > > You can use GIT_DEBUGGER to pick gdb by default, or you can hand it your > > own debugger if you like to use something else (or if you want custom > > flags for gdb). This commit documents that intent within > > CodingGuidelines. > > This last sentence is repeating what is already stated in the first > paragraph, thus doesn't seem to add value. In fact, the remainder of > the second paragraph seems to be repeating what is in the patch > proper, thus could likely be dropped. Yes, you're right. Dropped. > > > Signed-off-by: Emily Shaffer <firstname.lastname@example.org> > > --- > > diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines > > @@ -412,6 +412,12 @@ For C programs: > > + - 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 > > Don't you need to bind my-debugger-binary and my-args together with > shell quotes? Also, placeholders like these are often ensconced in > angle brackets, so perhaps: > > ... `GIT_DEBUGGER="<debugger> <debugger-args>" ./bin-wrappers/git ... Fixed. I did get the dq in the example but missed it with the placeholders. :) Thanks, good catch. > > + use your own debugger and arguments. Example: `GIT_DEBUGGER="ddd --gdb" > > + ./bin-wrappers/git log` (See `wrap-for-bin.sh`.) Patch update to follow. Thanks. - Emily
next prev parent reply other threads:[~2019-05-28 19:05 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 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 [this message] 2019-05-28 19:07 ` [PATCH v4] " Emily Shaffer
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 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 \ --in-reply-to=20190528190510.GA133078@google.com \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --firstname.lastname@example.org \ --subject='Re: [PATCH v3] doc: hint about GIT_DEBUGGER in CodingGuidelines' \ /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
Code repositories for project(s) associated with this inbox: https://80x24.org/mirrors/git.git 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).