From: Junio C Hamano <gitster@pobox.com>
Date: Mon, 17 Jun 2019 17:15:14 +0000 (-0700)
Subject: Merge branch 'es/git-debugger-doc'
X-Git-Tag: v2.23.0-rc0~125
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/7df94cd1f691dd6ccb3038e1b77544030aab3fed?hp=5d5c46b28c04348f7b680e5fe007c6344a86a70a

Merge branch 'es/git-debugger-doc'

Doc update.

* es/git-debugger-doc:
doc: hint about GIT_DEBUGGER in CodingGuidelines
---

diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 32210a4386..1169ff6c8e 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.