summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2020-05-01 20:39:58 (GMT)
committerJunio C Hamano <gitster@pobox.com>2020-05-01 20:39:59 (GMT)
commitdd094c2b75401f6e1e53e7a5bbfca3c66c44f556 (patch)
treec10b122157431d5be105f48436f909bdeb345381 /Documentation
parent6d6b412da32229bf6a5f366a72b5ad29cc70ce59 (diff)
parent8f0e9843bdf82b04591416367bee3817991e0722 (diff)
downloadgit-dd094c2b75401f6e1e53e7a5bbfca3c66c44f556.zip
git-dd094c2b75401f6e1e53e7a5bbfca3c66c44f556.tar.gz
git-dd094c2b75401f6e1e53e7a5bbfca3c66c44f556.tar.bz2
Merge branch 'es/bugreport'
The "bugreport" tool. * es/bugreport: bugreport: drop extraneous includes bugreport: add compiler info bugreport: add uname info bugreport: gather git version and build info bugreport: add tool to generate debugging info help: move list_config_help to builtin/help
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/git-bugreport.txt52
1 files changed, 52 insertions, 0 deletions
diff --git a/Documentation/git-bugreport.txt b/Documentation/git-bugreport.txt
new file mode 100644
index 0000000..643d1b2
--- /dev/null
+++ b/Documentation/git-bugreport.txt
@@ -0,0 +1,52 @@
+git-bugreport(1)
+================
+
+NAME
+----
+git-bugreport - Collect information for user to file a bug report
+
+SYNOPSIS
+--------
+[verse]
+'git bugreport' [(-o | --output-directory) <path>] [(-s | --suffix) <format>]
+
+DESCRIPTION
+-----------
+Captures information about the user's machine, Git client, and repository state,
+as well as a form requesting information about the behavior the user observed,
+into a single text file which the user can then share, for example to the Git
+mailing list, in order to report an observed bug.
+
+The following information is requested from the user:
+
+ - Reproduction steps
+ - Expected behavior
+ - Actual behavior
+
+The following information is captured automatically:
+
+ - 'git version --build-options'
+ - uname sysname, release, version, and machine strings
+ - Compiler-specific info string
+
+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
+the kind of information listed above when manually asking for help.
+
+OPTIONS
+-------
+-o <path>::
+--output-directory <path>::
+ Place the resulting bug report file in `<path>` instead of the root of
+ the Git repository.
+
+-s <format>::
+--suffix <format>::
+ Specify an alternate suffix for the bugreport name, to create a file
+ named 'git-bugreport-<formatted suffix>'. This should take the form of a
+ link:strftime[3] format string; the current local time will be used.
+
+GIT
+---
+Part of the linkgit:git[1] suite