{"thread":{"id":"51118","subject":"[PATCH] doc: hint about GIT_DEBUGGER","startedAt":"2019-05-17T20:48:34Z","lastAt":"2019-05-28T19:08:01Z","messageCount":10,"participants":["Emily Shaffer","Elijah Newren","Eric Sunshine"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"375828","messageId":"20190517204826.45308-1-emilyshaffer@google.com","threadId":"51118","inReplyTo":null,"subject":"[PATCH] doc: hint about GIT_DEBUGGER","fromName":"Emily Shaffer","fromEmail":"emilyshaffer@google.com","sentAt":"2019-05-17T20:48:26Z","receivedAt":"2019-05-17T20:48:34Z","isPatch":true,"sender":{"key":"nasamuffin@google.com","avatar":"https://avatars.githubusercontent.com/u/1606826?v=4"},"body":"We check for a handy environment variable GIT_DEBUGGER when running via\nbin-wrappers/, but this feature is undocumented. Add a hint to how to\nuse it into the CodingGuidelines (which is where other useful\nenvironment settings like DEVELOPER are documented).\n\nIt looks like you can use GIT_DEBUGGER to pick gdb by default, or you\ncan hand it your own debugger if you like to use something else (or if\nyou want custom flags for gdb). Hopefully document that intent within\nCodingGuidelines.\n\nSigned-off-by: Emily Shaffer <emilyshaffer@google.com>\n---\nMaybe this isn't the right place for this patch. But right now git grep\nreveals that GIT_DEBUGGER is completely undocumented.\n\nAlternatively, it might make sense to only add a short blurb about using\nGIT_DEBUGGER flag to CodingGuidelines and then documenting how to use it\ninside of wrap-for-bin.sh.\n\n Documentation/CodingGuidelines | 5 +++++\n 1 file changed, 5 insertions(+)\n\ndiff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines\nindex 32210a4386..e17cd75b50 100644\n--- a/Documentation/CodingGuidelines\n+++ b/Documentation/CodingGuidelines\n@@ -412,6 +412,11 @@ For C programs:\n    must be declared with \"extern\" in header files. However, function\n    declarations should not use \"extern\", as that is already the default.\n \n+ - You can launch gdb around your program using the shorthand GIT_DEBUGGER.\n+   Run `GIT_DEBUGGER=1 ./bin-wrappers/git foo` to simply use gdb as is, or\n+   run `GIT_DEBUGGER=debugger-binary some-args ./bin-wrappers/git foo` to\n+   use your own debugger and arguments. (See `wrap-for-bin.sh`.)\n+\n For Perl programs:\n \n  - Most of the C guidelines above apply.\n-- \n2.21.0.1020.gf2820cf01a-goog\n\n"},{"id":"375841","messageId":"CABPp-BHZkQG+pr4MmVGahHDR56grqvRsYNxZ=uShK70APzj9LA@mail.gmail.com","threadId":"51118","inReplyTo":"20190517204826.45308-1-emilyshaffer@google.com","subject":"Re: [PATCH] doc: hint about GIT_DEBUGGER","fromName":"Elijah Newren","fromEmail":"newren@gmail.com","sentAt":"2019-05-18T05:40:27Z","receivedAt":"2019-05-18T05:45:56Z","isPatch":true,"sender":{"key":"newren@gmail.com","avatar":"https://avatars.githubusercontent.com/u/5455730?v=4"},"body":"Hi Emily,\n\nOn Fri, May 17, 2019 at 3:40 PM Emily Shaffer <emilyshaffer@google.com> wrote:\n>\n> We check for a handy environment variable GIT_DEBUGGER when running via\n> bin-wrappers/, but this feature is undocumented. Add a hint to how to\n> use it into the CodingGuidelines (which is where other useful\n> environment settings like DEVELOPER are documented).\n>\n> It looks like you can use GIT_DEBUGGER to pick gdb by default, or you\n> can hand it your own debugger if you like to use something else (or if\n> you want custom flags for gdb). Hopefully document that intent within\n> CodingGuidelines.\n\nThanks for working on this.\n\n> Signed-off-by: Emily Shaffer <emilyshaffer@google.com>\n> ---\n> Maybe this isn't the right place for this patch. But right now git grep\n> reveals that GIT_DEBUGGER is completely undocumented.\n\nDoes 'git log --grep=GIT_DEBUGGER' count?  ;-)\n\n> Alternatively, it might make sense to only add a short blurb about using\n> GIT_DEBUGGER flag to CodingGuidelines and then documenting how to use it\n> inside of wrap-for-bin.sh.\n>\n>  Documentation/CodingGuidelines | 5 +++++\n>  1 file changed, 5 insertions(+)\n>\n> diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines\n> index 32210a4386..e17cd75b50 100644\n> --- a/Documentation/CodingGuidelines\n> +++ b/Documentation/CodingGuidelines\n> @@ -412,6 +412,11 @@ For C programs:\n>     must be declared with \"extern\" in header files. However, function\n>     declarations should not use \"extern\", as that is already the default.\n>\n> + - You can launch gdb around your program using the shorthand GIT_DEBUGGER.\n> +   Run `GIT_DEBUGGER=1 ./bin-wrappers/git foo` to simply use gdb as is, or\n> +   run `GIT_DEBUGGER=debugger-binary some-args ./bin-wrappers/git foo` to\n\nMissing some quotes around debugger-binary and some-args:\n+   run `GIT_DEBUGGER=\"debugger-binary some-args\" ./bin-wrappers/git foo` to\n\nAlso, one thing I always wonder about with command documentation like\nthis is whether people will understand that \"debugger-binary\",\n\"some-args\", and \"foo\" are just placeholders rather than literal text\n-- and that everything else is literal text and not meant to be\nplaceholders.  Does it make since to include a couple examples, or\nperhaps modify the text somehow to avoid confusion between\nplaceholders and literals, or maybe just tell me I overthinking this?\n(I've been bit by similar problems in other contexts, so I'm just\nflagging it for you to consider).\n\nElijah\n"},{"id":"375954","messageId":"20190520203843.GA64994@google.com","threadId":"51118","inReplyTo":"CABPp-BHZkQG+pr4MmVGahHDR56grqvRsYNxZ=uShK70APzj9LA@mail.gmail.com","subject":"Re: [PATCH] doc: hint about GIT_DEBUGGER","fromName":"Emily Shaffer","fromEmail":"emilyshaffer@google.com","sentAt":"2019-05-20T20:38:43Z","receivedAt":"2019-05-20T20:38:51Z","isPatch":true,"sender":{"key":"nasamuffin@google.com","avatar":"https://avatars.githubusercontent.com/u/1606826?v=4"},"body":"[snip]\n\n> > + - You can launch gdb around your program using the shorthand GIT_DEBUGGER.\n> > +   Run `GIT_DEBUGGER=1 ./bin-wrappers/git foo` to simply use gdb as is, or\n> > +   run `GIT_DEBUGGER=debugger-binary some-args ./bin-wrappers/git foo` to\n> \n> Missing some quotes around debugger-binary and some-args:\n> +   run `GIT_DEBUGGER=\"debugger-binary some-args\" ./bin-wrappers/git foo` to\n> \n> Also, one thing I always wonder about with command documentation like\n> this is whether people will understand that \"debugger-binary\",\n> \"some-args\", and \"foo\" are just placeholders rather than literal text\n> -- and that everything else is literal text and not meant to be\n> placeholders.  Does it make since to include a couple examples, or\n> perhaps modify the text somehow to avoid confusion between\n> placeholders and literals, or maybe just tell me I overthinking this?\n> (I've been bit by similar problems in other contexts, so I'm just\n> flagging it for you to consider).\n\nIt's a good point. I like to use placeholders that don't sound like a\nreal command (and failed a little here), for example,\n`GIT_DEBUGGER=my-cool-debugger some-various-args`. It can be a challenge\nto choose a placeholder that sounds fake but also doesn't sound too\ninformal (the above feels informal to me). I think the best way is to\nshow an example, that's a good idea. I'll come up with one and send\nanother round this week.\n\nThanks a bunch for having a look.\n\n - Emily\n\n> \n> Elijah\n"},{"id":"375971","messageId":"20190521010036.70378-1-emilyshaffer@google.com","threadId":"51118","inReplyTo":"20190517204826.45308-1-emilyshaffer@google.com","subject":"[PATCH v2] doc: hint about GIT_DEBUGGER","fromName":"Emily Shaffer","fromEmail":"emilyshaffer@google.com","sentAt":"2019-05-21T01:00:37Z","receivedAt":"2019-05-21T01:01:20Z","isPatch":true,"sender":{"key":"nasamuffin@google.com","avatar":"https://avatars.githubusercontent.com/u/1606826?v=4"},"body":"We check for a handy environment variable GIT_DEBUGGER when running via\nbin-wrappers/, but this feature is undocumented. Add a hint to how to\nuse it into the CodingGuidelines (which is where other useful\nenvironment settings like DEVELOPER are documented).\n\nIt looks like you can use GIT_DEBUGGER to pick gdb by default, or you\ncan hand it your own debugger if you like to use something else (or if\nyou want custom flags for gdb). Hopefully document that intent within\nCodingGuidelines.\n\nSigned-off-by: Emily Shaffer <emilyshaffer@google.com>\n---\n Documentation/CodingGuidelines | 6 ++++++\n 1 file changed, 6 insertions(+)\n\ndiff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines\nindex 32210a4386..e99af36df9 100644\n--- a/Documentation/CodingGuidelines\n+++ b/Documentation/CodingGuidelines\n@@ -412,6 +412,12 @@ For C programs:\n    must be declared with \"extern\" in header files. However, function\n    declarations should not use \"extern\", as that is already the default.\n \n+ - You can launch gdb around your program using the shorthand GIT_DEBUGGER.\n+   Run `GIT_DEBUGGER=1 ./bin-wrappers/git foo` to simply use gdb as is, or\n+   run `GIT_DEBUGGER=my-debugger-binary my-args ./bin-wrappers/git foo` to\n+   use your own debugger and arguments. Example: `GIT_DEBUGGER=\"ddd --gdb\"\n+   ./bin-wrappers/git log` (See `wrap-for-bin.sh`.)\n+\n For Perl programs:\n \n  - Most of the C guidelines above apply.\n-- \n2.21.0.1020.gf2820cf01a-goog\n\n"},{"id":"376002","messageId":"CABPp-BHehO4dJCpNHws=PAaqxTyoeLyb3N1BGFG+AEEgBYVtBQ@mail.gmail.com","threadId":"51118","inReplyTo":"20190521010036.70378-1-emilyshaffer@google.com","subject":"Re: [PATCH v2] doc: hint about GIT_DEBUGGER","fromName":"Elijah Newren","fromEmail":"newren@gmail.com","sentAt":"2019-05-21T16:06:18Z","receivedAt":"2019-05-21T16:06:31Z","isPatch":true,"sender":{"key":"newren@gmail.com","avatar":"https://avatars.githubusercontent.com/u/5455730?v=4"},"body":"On Mon, May 20, 2019 at 6:01 PM Emily Shaffer <emilyshaffer@google.com> wrote:\n>\n> We check for a handy environment variable GIT_DEBUGGER when running via\n> bin-wrappers/, but this feature is undocumented. Add a hint to how to\n> use it into the CodingGuidelines (which is where other useful\n> environment settings like DEVELOPER are documented).\n>\n\nTwo very minor nits:\n\n> It looks like you can use GIT_DEBUGGER to pick gdb by default, or you\n\nI think it'd sound better without 'It looks like'; perhaps drop that part?\n\n> can hand it your own debugger if you like to use something else (or if\n> you want custom flags for gdb). Hopefully document that intent within\n> CodingGuidelines.\n\nMaybe just leave out 'Hopefully'?\n\n>\n> Signed-off-by: Emily Shaffer <emilyshaffer@google.com>\n> ---\n>  Documentation/CodingGuidelines | 6 ++++++\n>  1 file changed, 6 insertions(+)\n>\n> diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines\n> index 32210a4386..e99af36df9 100644\n> --- a/Documentation/CodingGuidelines\n> +++ b/Documentation/CodingGuidelines\n> @@ -412,6 +412,12 @@ For C programs:\n>     must be declared with \"extern\" in header files. However, function\n>     declarations should not use \"extern\", as that is already the default.\n>\n> + - You can launch gdb around your program using the shorthand GIT_DEBUGGER.\n> +   Run `GIT_DEBUGGER=1 ./bin-wrappers/git foo` to simply use gdb as is, or\n> +   run `GIT_DEBUGGER=my-debugger-binary my-args ./bin-wrappers/git foo` to\n> +   use your own debugger and arguments. Example: `GIT_DEBUGGER=\"ddd --gdb\"\n> +   ./bin-wrappers/git log` (See `wrap-for-bin.sh`.)\n> +\n\nOther than the minor nits above:\nAcked-by: Elijah Newren <newren@gmail.com>\n"},{"id":"376007","messageId":"20190521181943.GA82620@google.com","threadId":"51118","inReplyTo":"CABPp-BHehO4dJCpNHws=PAaqxTyoeLyb3N1BGFG+AEEgBYVtBQ@mail.gmail.com","subject":"Re: [PATCH v2] doc: hint about GIT_DEBUGGER","fromName":"Emily Shaffer","fromEmail":"emilyshaffer@google.com","sentAt":"2019-05-21T18:19:43Z","receivedAt":"2019-05-21T18:19:55Z","isPatch":true,"sender":{"key":"nasamuffin@google.com","avatar":"https://avatars.githubusercontent.com/u/1606826?v=4"},"body":"On Tue, May 21, 2019 at 09:06:18AM -0700, Elijah Newren wrote:\n> On Mon, May 20, 2019 at 6:01 PM Emily Shaffer <emilyshaffer@google.com> wrote:\n> >\n> > We check for a handy environment variable GIT_DEBUGGER when running via\n> > bin-wrappers/, but this feature is undocumented. Add a hint to how to\n> > use it into the CodingGuidelines (which is where other useful\n> > environment settings like DEVELOPER are documented).\n> >\n> \n> Two very minor nits:\n> \n> > It looks like you can use GIT_DEBUGGER to pick gdb by default, or you\n> \n> I think it'd sound better without 'It looks like'; perhaps drop that part?\n> \n> > can hand it your own debugger if you like to use something else (or if\n> > you want custom flags for gdb). Hopefully document that intent within\n> > CodingGuidelines.\n> \n> Maybe just leave out 'Hopefully'?\n> \n> >\n> > Signed-off-by: Emily Shaffer <emilyshaffer@google.com>\n> > ---\n> >  Documentation/CodingGuidelines | 6 ++++++\n> >  1 file changed, 6 insertions(+)\n> >\n> > diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines\n> > index 32210a4386..e99af36df9 100644\n> > --- a/Documentation/CodingGuidelines\n> > +++ b/Documentation/CodingGuidelines\n> > @@ -412,6 +412,12 @@ For C programs:\n> >     must be declared with \"extern\" in header files. However, function\n> >     declarations should not use \"extern\", as that is already the default.\n> >\n> > + - You can launch gdb around your program using the shorthand GIT_DEBUGGER.\n> > +   Run `GIT_DEBUGGER=1 ./bin-wrappers/git foo` to simply use gdb as is, or\n> > +   run `GIT_DEBUGGER=my-debugger-binary my-args ./bin-wrappers/git foo` to\n> > +   use your own debugger and arguments. Example: `GIT_DEBUGGER=\"ddd --gdb\"\n> > +   ./bin-wrappers/git log` (See `wrap-for-bin.sh`.)\n> > +\n> \n> Other than the minor nits above:\n> Acked-by: Elijah Newren <newren@gmail.com>\n\nMade both the changes you recommended; I'll hang onto it locally until\nthis afternoon in case anybody else has something to say. Thanks for\nlooking, Elijah.\n\n - Emily\n"},{"id":"376092","messageId":"20190523005533.260611-1-emilyshaffer@google.com","threadId":"51118","inReplyTo":"20190521010036.70378-1-emilyshaffer@google.com","subject":"[PATCH v3] doc: hint about GIT_DEBUGGER in CodingGuidelines","fromName":"Emily Shaffer","fromEmail":"emilyshaffer@google.com","sentAt":"2019-05-23T00:55:33Z","receivedAt":"2019-05-23T00:55:56Z","isPatch":true,"sender":{"key":"nasamuffin@google.com","avatar":"https://avatars.githubusercontent.com/u/1606826?v=4"},"body":"We check for a handy environment variable GIT_DEBUGGER when running via\nbin-wrappers/, but this feature is undocumented. Add a hint to how to\nuse it into the CodingGuidelines (which is where other useful\nenvironment settings like DEVELOPER are documented).\n\nYou can use GIT_DEBUGGER to pick gdb by default, or you can hand it your\nown debugger if you like to use something else (or if you want custom\nflags for gdb). This commit documents that intent within\nCodingGuidelines.\n\nSigned-off-by: Emily Shaffer <emilyshaffer@google.com>\n---\n\nSince v2, only the commit message has changed. Removed some weak\nlanguage to make the commit message read more easily.\n\n Documentation/CodingGuidelines | 6 ++++++\n 1 file changed, 6 insertions(+)\n\ndiff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines\nindex 32210a4386..e99af36df9 100644\n--- a/Documentation/CodingGuidelines\n+++ b/Documentation/CodingGuidelines\n@@ -412,6 +412,12 @@ For C programs:\n    must be declared with \"extern\" in header files. However, function\n    declarations should not use \"extern\", as that is already the default.\n \n+ - You can launch gdb around your program using the shorthand GIT_DEBUGGER.\n+   Run `GIT_DEBUGGER=1 ./bin-wrappers/git foo` to simply use gdb as is, or\n+   run `GIT_DEBUGGER=my-debugger-binary my-args ./bin-wrappers/git foo` to\n+   use your own debugger and arguments. Example: `GIT_DEBUGGER=\"ddd --gdb\"\n+   ./bin-wrappers/git log` (See `wrap-for-bin.sh`.)\n+\n For Perl programs:\n \n  - Most of the C guidelines above apply.\n-- \n2.21.0.1020.gf2820cf01a-goog\n\n"},{"id":"376100","messageId":"CAPig+cQSp2pY9_fYhDPO+YwEmVXiqB+wjhL9NTcA+Mc_TQbWHg@mail.gmail.com","threadId":"51118","inReplyTo":"20190523005533.260611-1-emilyshaffer@google.com","subject":"Re: [PATCH v3] doc: hint about GIT_DEBUGGER in CodingGuidelines","fromName":"Eric Sunshine","fromEmail":"sunshine@sunshineco.com","sentAt":"2019-05-23T10:09:17Z","receivedAt":"2019-05-23T10:09:31Z","isPatch":true,"sender":{"key":"sunshine@sunshineco.com","avatar":"https://avatars.githubusercontent.com/u/163641?v=4"},"body":"On Wed, May 22, 2019 at 8:56 PM Emily Shaffer <emilyshaffer@google.com> wrote:\n> We check for a handy environment variable GIT_DEBUGGER when running via\n> bin-wrappers/, but this feature is undocumented. Add a hint to how to\n> use it into the CodingGuidelines (which is where other useful\n> environment settings like DEVELOPER are documented).\n>\n> You can use GIT_DEBUGGER to pick gdb by default, or you can hand it your\n> own debugger if you like to use something else (or if you want custom\n> flags for gdb). This commit documents that intent within\n> CodingGuidelines.\n\nThis last sentence is repeating what is already stated in the first\nparagraph, thus doesn't seem to add value. In fact, the remainder of\nthe second paragraph seems to be repeating what is in the patch\nproper, thus could likely be dropped.\n\n> Signed-off-by: Emily Shaffer <emilyshaffer@google.com>\n> ---\n> diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines\n> @@ -412,6 +412,12 @@ For C programs:\n> + - You can launch gdb around your program using the shorthand GIT_DEBUGGER.\n> +   Run `GIT_DEBUGGER=1 ./bin-wrappers/git foo` to simply use gdb as is, or\n> +   run `GIT_DEBUGGER=my-debugger-binary my-args ./bin-wrappers/git foo` to\n\nDon't you need to bind my-debugger-binary and my-args together with\nshell quotes? Also, placeholders like these are often ensconced in\nangle brackets, so perhaps:\n\n    ... `GIT_DEBUGGER=\"<debugger> <debugger-args>\" ./bin-wrappers/git ...\n\n> +   use your own debugger and arguments. Example: `GIT_DEBUGGER=\"ddd --gdb\"\n> +   ./bin-wrappers/git log` (See `wrap-for-bin.sh`.)\n"},{"id":"376339","messageId":"20190528190510.GA133078@google.com","threadId":"51118","inReplyTo":"CAPig+cQSp2pY9_fYhDPO+YwEmVXiqB+wjhL9NTcA+Mc_TQbWHg@mail.gmail.com","subject":"Re: [PATCH v3] doc: hint about GIT_DEBUGGER in CodingGuidelines","fromName":"Emily Shaffer","fromEmail":"emilyshaffer@google.com","sentAt":"2019-05-28T19:05:10Z","receivedAt":"2019-05-28T19:05:18Z","isPatch":true,"sender":{"key":"nasamuffin@google.com","avatar":"https://avatars.githubusercontent.com/u/1606826?v=4"},"body":"On Thu, May 23, 2019 at 06:09:17AM -0400, Eric Sunshine wrote:\n> On Wed, May 22, 2019 at 8:56 PM Emily Shaffer <emilyshaffer@google.com> wrote:\n> > We check for a handy environment variable GIT_DEBUGGER when running via\n> > bin-wrappers/, but this feature is undocumented. Add a hint to how to\n> > use it into the CodingGuidelines (which is where other useful\n> > environment settings like DEVELOPER are documented).\n> >\n> > You can use GIT_DEBUGGER to pick gdb by default, or you can hand it your\n> > own debugger if you like to use something else (or if you want custom\n> > flags for gdb). This commit documents that intent within\n> > CodingGuidelines.\n> \n> This last sentence is repeating what is already stated in the first\n> paragraph, thus doesn't seem to add value. In fact, the remainder of\n> the second paragraph seems to be repeating what is in the patch\n> proper, thus could likely be dropped.\n\nYes, you're right. Dropped.\n\n> \n> > Signed-off-by: Emily Shaffer <emilyshaffer@google.com>\n> > ---\n> > diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines\n> > @@ -412,6 +412,12 @@ For C programs:\n> > + - You can launch gdb around your program using the shorthand GIT_DEBUGGER.\n> > +   Run `GIT_DEBUGGER=1 ./bin-wrappers/git foo` to simply use gdb as is, or\n> > +   run `GIT_DEBUGGER=my-debugger-binary my-args ./bin-wrappers/git foo` to\n> \n> Don't you need to bind my-debugger-binary and my-args together with\n> shell quotes? Also, placeholders like these are often ensconced in\n> angle brackets, so perhaps:\n> \n>     ... `GIT_DEBUGGER=\"<debugger> <debugger-args>\" ./bin-wrappers/git ...\n\nFixed. I did get the dq in the example but missed it with the\nplaceholders. :) Thanks, good catch.\n\n> > +   use your own debugger and arguments. Example: `GIT_DEBUGGER=\"ddd --gdb\"\n> > +   ./bin-wrappers/git log` (See `wrap-for-bin.sh`.)\n\nPatch update to follow. Thanks.\n\n - Emily\n"},{"id":"376341","messageId":"20190528190729.78029-1-emilyshaffer@google.com","threadId":"51118","inReplyTo":"20190523005533.260611-1-emilyshaffer@google.com","subject":"[PATCH v4] doc: hint about GIT_DEBUGGER in CodingGuidelines","fromName":"Emily Shaffer","fromEmail":"emilyshaffer@google.com","sentAt":"2019-05-28T19:07:29Z","receivedAt":"2019-05-28T19:08:01Z","isPatch":true,"sender":{"key":"nasamuffin@google.com","avatar":"https://avatars.githubusercontent.com/u/1606826?v=4"},"body":"We check for a handy environment variable GIT_DEBUGGER when running via\nbin-wrappers/, but this feature is undocumented. Add a hint to how to\nuse it into the CodingGuidelines (which is where other useful\nenvironment settings like DEVELOPER are documented).\n\nSigned-off-by: Emily Shaffer <emilyshaffer@google.com>\n---\n Documentation/CodingGuidelines | 6 ++++++\n 1 file changed, 6 insertions(+)\n\ndiff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines\nindex 32210a4386..1169ff6c8e 100644\n--- a/Documentation/CodingGuidelines\n+++ b/Documentation/CodingGuidelines\n@@ -412,6 +412,12 @@ For C programs:\n    must be declared with \"extern\" in header files. However, function\n    declarations should not use \"extern\", as that is already the default.\n \n+ - You can launch gdb around your program using the shorthand GIT_DEBUGGER.\n+   Run `GIT_DEBUGGER=1 ./bin-wrappers/git foo` to simply use gdb as is, or\n+   run `GIT_DEBUGGER=\"<debugger> <debugger-args>\" ./bin-wrappers/git foo` to\n+   use your own debugger and arguments. Example: `GIT_DEBUGGER=\"ddd --gdb\"\n+   ./bin-wrappers/git log` (See `wrap-for-bin.sh`.)\n+\n For Perl programs:\n \n  - Most of the C guidelines above apply.\n-- \n2.22.0.rc1.257.g3120a18244-goog\n\n"}]}