We check for a handy environment variable GIT_DEBUGGER when running via
bin-wrappers/, but this feature is undocumented. Add a hint to how to
use it into the CodingGuidelines (which is where other useful
environment settings like DEVELOPER are documented).
You can use GIT_DEBUGGER to pick gdb by default, or you can hand it your
own debugger if you like to use something else (or if you want custom
flags for gdb). This commit documents that intent within
CodingGuidelines.
Signed-off-by: Emily Shaffer <emilyshaffer@xxxxxxxxxx>
---
Since v2, only the commit message has changed. Removed some weak
language to make the commit message read more easily.
Documentation/CodingGuidelines | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 32210a4386..e99af36df9 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=my-debugger-binary my-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.
--
2.21.0.1020.gf2820cf01a-goog
