Merge branch 'es/git-debugger-doc'
authorJunio C Hamano <gitster@pobox.com>
Mon, 17 Jun 2019 17:15:14 +0000 (10:15 -0700)
committerJunio C Hamano <gitster@pobox.com>
Mon, 17 Jun 2019 17:15:14 +0000 (10:15 -0700)
Doc update.

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

1  2 
Documentation/CodingGuidelines
index 32210a4386c32972b7c4dbfa36b0cf977dd85de2,d67a35ad5d99baa2399db317e71fc1253f8c4ef5..1169ff6c8eb87e6e372110a89f31273879bc862f
@@@ -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`