Merge branch 'pw/add-p-recount' into maint

[thirdparty/git.git] / Documentation / CodingGuidelines

diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 32210a4386c32972b7c4dbfa36b0cf977dd85de2..1169ff6c8eb87e6e372110a89f31273879bc862f 100644 (file)
--- 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.
 
    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.
 For Perl programs:
 
  - Most of the C guidelines above apply.