From: Junio C Hamano <gitster@pobox.com>
Date: Thu, 25 Jul 2019 21:27:14 +0000 (-0700)
Subject: Merge branch 'es/git-debugger-doc' into maint
X-Git-Tag: v2.23.0-rc0~6^2~5
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/24c161ddd6f614d27a12eebd53c9476cfb87c0ab?ds=sidebyside;hp=-c

Merge branch 'es/git-debugger-doc' into maint

Doc update.

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

24c161ddd6f614d27a12eebd53c9476cfb87c0ab
diff --combined Documentation/CodingGuidelines
index 32210a4386,d67a35ad5d..1169ff6c8e
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@@ -412,6 -412,12 +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.
@@@ -580,14 -586,11 +586,14 @@@ Writing Documentation
   or commands:
  
   Literal examples (e.g. use of command-line options, command names,
 - branch names, configuration and environment variables) must be
 - typeset in monospace (i.e. wrapped with backticks):
 + branch names, URLs, pathnames (files and directories), configuration and
 + environment variables) must be typeset in monospace (i.e. wrapped with
 + backticks):
     `--pretty=oneline`
     `git rev-list`
     `remote.pushDefault`
 +   `http://git.example.com`
 +   `.git/config`
     `GIT_DIR`
     `HEAD`