doc: hint about GIT_DEBUGGER in CodingGuidelines
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). Signed-off-by: Emily Shaffer <emilyshaffer@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Emily Shaffer committed
May 28, 2019 at 12:07 UTC
f547101b26449c65aefd378022277ebb953eb7a6
1 file changed
+6
Documentation/CodingGuidelines
+6
@@ -412,6 +412,12 @@ For C programs:
412
must be declared with "extern" in header files. However, function
413
declarations should not use "extern", as that is already the default.
414
415
+ - You can launch gdb around your program using the shorthand GIT_DEBUGGER.
416
+ Run `GIT_DEBUGGER=1 ./bin-wrappers/git foo` to simply use gdb as is, or
417
+ run `GIT_DEBUGGER="<debugger> <debugger-args>" ./bin-wrappers/git foo` to
418
+ use your own debugger and arguments. Example: `GIT_DEBUGGER="ddd --gdb"
419
+ ./bin-wrappers/git log` (See `wrap-for-bin.sh`.)
420
+
421
For Perl programs:
422
423
- Most of the C guidelines above apply.