On Mon, May 20, 2019 at 6:01 PM Emily Shaffer <emilyshaffer@xxxxxxxxxx> 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 <emilyshaffer@xxxxxxxxxx> > --- > 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 <newren@xxxxxxxxx>
