summaryrefslogtreecommitdiff
path: root/Documentation/git-bugreport.txt
diff options
context:
space:
mode:
authorLibravatar Emily Shaffer <emilyshaffer@google.com>2020-04-16 14:18:05 -0700
committerLibravatar Junio C Hamano <gitster@pobox.com>2020-04-16 15:23:42 -0700
commit617d57195ae844a43486b2e0ad0b7ac36aaddfdd (patch)
tree4e0a61c93d3fb555cdb5d7f01e0ea9826f1ced2b /Documentation/git-bugreport.txt
parentbugreport: add tool to generate debugging info (diff)
downloadtgif-617d57195ae844a43486b2e0ad0b7ac36aaddfdd.tar.xz
bugreport: gather git version and build info
Knowing which version of Git a user has and how it was built allows us to more precisely pin down the circumstances when a certain issue occurs, so teach bugreport how to tell us the same output as 'git version --build-options'. It's not ideal to directly call 'git version --build-options' because that output goes to stdout. Instead, wrap the version string in a helper within help.[ch] library, and call that helper from within the bugreport library. Signed-off-by: Emily Shaffer <emilyshaffer@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-bugreport.txt')
-rw-r--r--Documentation/git-bugreport.txt4
1 files changed, 4 insertions, 0 deletions
diff --git a/Documentation/git-bugreport.txt b/Documentation/git-bugreport.txt
index 1f9fde5cde..f44ae8cbe7 100644
--- a/Documentation/git-bugreport.txt
+++ b/Documentation/git-bugreport.txt
@@ -23,6 +23,10 @@ The following information is requested from the user:
- Expected behavior
- Actual behavior
+The following information is captured automatically:
+
+ - 'git version --build-options'
+
This tool is invoked via the typical Git setup process, which means that in some
cases, it might not be able to launch - for example, if a relevant config file
is unreadable. In this kind of scenario, it may be helpful to manually gather