Skip to content

Commit f547101

Browse files
nasamuffingitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent aeb582a commit f547101

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

Documentation/CodingGuidelines

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -412,6 +412,12 @@ For C programs:
412412
must be declared with "extern" in header files. However, function
413413
declarations should not use "extern", as that is already the default.
414414

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+
415421
For Perl programs:
416422

417423
- Most of the C guidelines above apply.

0 commit comments

Comments
 (0)