From: Elijah Newren <email@example.com> To: Emily Shaffer <firstname.lastname@example.org> Cc: Git Mailing List <email@example.com> Subject: Re: [PATCH] doc: hint about GIT_DEBUGGER Date: Fri, 17 May 2019 22:40:27 -0700 [thread overview] Message-ID: <CABPp-BHZkQG+pr4MmVGahHDR56grqvRsYNxZ=uShK70APzj9LA@mail.gmail.com> (raw) In-Reply-To: <firstname.lastname@example.org> Hi Emily, On Fri, May 17, 2019 at 3:40 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). > > It looks like 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). Hopefully document that intent within > CodingGuidelines. Thanks for working on this. > Signed-off-by: Emily Shaffer <firstname.lastname@example.org> > --- > Maybe this isn't the right place for this patch. But right now git grep > reveals that GIT_DEBUGGER is completely undocumented. Does 'git log --grep=GIT_DEBUGGER' count? ;-) > Alternatively, it might make sense to only add a short blurb about using > GIT_DEBUGGER flag to CodingGuidelines and then documenting how to use it > inside of wrap-for-bin.sh. > > Documentation/CodingGuidelines | 5 +++++ > 1 file changed, 5 insertions(+) > > diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines > index 32210a4386..e17cd75b50 100644 > --- a/Documentation/CodingGuidelines > +++ b/Documentation/CodingGuidelines > @@ -412,6 +412,11 @@ 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=debugger-binary some-args ./bin-wrappers/git foo` to Missing some quotes around debugger-binary and some-args: + run `GIT_DEBUGGER="debugger-binary some-args" ./bin-wrappers/git foo` to Also, one thing I always wonder about with command documentation like this is whether people will understand that "debugger-binary", "some-args", and "foo" are just placeholders rather than literal text -- and that everything else is literal text and not meant to be placeholders. Does it make since to include a couple examples, or perhaps modify the text somehow to avoid confusion between placeholders and literals, or maybe just tell me I overthinking this? (I've been bit by similar problems in other contexts, so I'm just flagging it for you to consider). Elijah
next prev parent reply other threads:[~2019-05-18 5:45 UTC|newest] Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top 2019-05-17 20:48 Emily Shaffer 2019-05-18 5:40 ` Elijah Newren [this message] 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 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='CABPp-BHZkQG+pr4MmVGahHDR56grqvRsYNxZ=uShK70APzj9LA@mail.gmail.com' \ --email@example.com \ --firstname.lastname@example.org \ --email@example.com \ --subject='Re: [PATCH] doc: hint about GIT_DEBUGGER' \ /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).