diff options
| author |  Emily Shaffer <emilyshaffer@google.com> | 2019-05-28 12:07:29 -0700 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2019-05-28 13:42:33 -0700 |
| commit | f547101b26449c65aefd378022277ebb953eb7a6 (patch) | |
| tree | 3f306bd3f417cb1066a89e71177e9ef92821d88f /Documentation/CodingGuidelines | |
| parent | mingw: allow building with an MSYS2 runtime v3.x (diff) | |
| download | tgif-f547101b26449c65aefd378022277ebb953eb7a6.tar.xz | |
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>
Diffstat (limited to 'Documentation/CodingGuidelines')
| -rw-r--r-- | Documentation/CodingGuidelines | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines index 8579530710..d67a35ad5d 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="<debugger> <debugger-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`.) + For Perl programs: - Most of the C guidelines above apply. |