summaryrefslogtreecommitdiff
path: root/Documentation/CodingGuidelines
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2019-06-17 17:15:14 (GMT)
committerJunio C Hamano <gitster@pobox.com>2019-06-17 17:15:14 (GMT)
commit7df94cd1f691dd6ccb3038e1b77544030aab3fed (patch)
tree61f9b972343d0fca48ec273f9ef8a2d327f07251 /Documentation/CodingGuidelines
parent5d5c46b28c04348f7b680e5fe007c6344a86a70a (diff)
parentf547101b26449c65aefd378022277ebb953eb7a6 (diff)
downloadgit-7df94cd1f691dd6ccb3038e1b77544030aab3fed.zip
git-7df94cd1f691dd6ccb3038e1b77544030aab3fed.tar.gz
git-7df94cd1f691dd6ccb3038e1b77544030aab3fed.tar.bz2
Merge branch 'es/git-debugger-doc'
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 32210a4..1169ff6 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.