summaryrefslogtreecommitdiff
path: root/Documentation/CodingGuidelines
diff options
context:
space:
mode:
authorLibravatar Junio C Hamano <gitster@pobox.com>2019-07-25 14:27:14 -0700
committerLibravatar Junio C Hamano <gitster@pobox.com>2019-07-25 14:27:14 -0700
commit24c161ddd6f614d27a12eebd53c9476cfb87c0ab (patch)
tree5d68aa41d5063bac7c9277fa00c33037b2bfa027 /Documentation/CodingGuidelines
parentMerge branch 'mo/clang-format-for-each-update' into maint (diff)
parentdoc: hint about GIT_DEBUGGER in CodingGuidelines (diff)
downloadtgif-24c161ddd6f614d27a12eebd53c9476cfb87c0ab.tar.xz
Merge branch 'es/git-debugger-doc' into maint
Doc update. * es/git-debugger-doc: doc: hint about GIT_DEBUGGER in CodingGuidelines
Diffstat (limited to 'Documentation/CodingGuidelines')
-rw-r--r--Documentation/CodingGuidelines6
1 files changed, 6 insertions, 0 deletions
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.