| '\" t |
| .\" Title: git-bugreport |
| .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] |
| .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> |
| .\" Date: 2024-04-29 |
| .\" Manual: Git Manual |
| .\" Source: Git 2.45.0 |
| .\" Language: English |
| .\" |
| .TH "GIT\-BUGREPORT" "1" "2024\-04\-29" "Git 2\&.45\&.0" "Git Manual" |
| .\" ----------------------------------------------------------------- |
| .\" * Define some portability stuff |
| .\" ----------------------------------------------------------------- |
| .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| .\" http://bugs.debian.org/507673 |
| .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html |
| .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
| .ie \n(.g .ds Aq \(aq |
| .el .ds Aq ' |
| .\" ----------------------------------------------------------------- |
| .\" * set default formatting |
| .\" ----------------------------------------------------------------- |
| .\" disable hyphenation |
| .nh |
| .\" disable justification (adjust text to left margin only) |
| .ad l |
| .\" ----------------------------------------------------------------- |
| .\" * MAIN CONTENT STARTS HERE * |
| .\" ----------------------------------------------------------------- |
| .SH "NAME" |
| git-bugreport \- Collect information for user to file a bug report |
| .SH "SYNOPSIS" |
| .sp |
| .nf |
| \fIgit bugreport\fR [(\-o | \-\-output\-directory) <path>] |
| [(\-s | \-\-suffix) <format> | \-\-no\-suffix] |
| [\-\-diagnose[=<mode>]] |
| .fi |
| .sp |
| .SH "DESCRIPTION" |
| .sp |
| Collects information about the user\(cqs machine, Git client, and repository state, in addition to a form requesting information about the behavior the user observed, and stores it in a single text file which the user can then share, for example to the Git mailing list, in order to report an observed bug\&. |
| .sp |
| The following information is requested from the user: |
| .sp |
| .RS 4 |
| .ie n \{\ |
| \h'-04'\(bu\h'+03'\c |
| .\} |
| .el \{\ |
| .sp -1 |
| .IP \(bu 2.3 |
| .\} |
| Reproduction steps |
| .RE |
| .sp |
| .RS 4 |
| .ie n \{\ |
| \h'-04'\(bu\h'+03'\c |
| .\} |
| .el \{\ |
| .sp -1 |
| .IP \(bu 2.3 |
| .\} |
| Expected behavior |
| .RE |
| .sp |
| .RS 4 |
| .ie n \{\ |
| \h'-04'\(bu\h'+03'\c |
| .\} |
| .el \{\ |
| .sp -1 |
| .IP \(bu 2.3 |
| .\} |
| Actual behavior |
| .RE |
| .sp |
| The following information is captured automatically: |
| .sp |
| .RS 4 |
| .ie n \{\ |
| \h'-04'\(bu\h'+03'\c |
| .\} |
| .el \{\ |
| .sp -1 |
| .IP \(bu 2.3 |
| .\} |
| \fIgit version \-\-build\-options\fR |
| .RE |
| .sp |
| .RS 4 |
| .ie n \{\ |
| \h'-04'\(bu\h'+03'\c |
| .\} |
| .el \{\ |
| .sp -1 |
| .IP \(bu 2.3 |
| .\} |
| uname sysname, release, version, and machine strings |
| .RE |
| .sp |
| .RS 4 |
| .ie n \{\ |
| \h'-04'\(bu\h'+03'\c |
| .\} |
| .el \{\ |
| .sp -1 |
| .IP \(bu 2.3 |
| .\} |
| Compiler\-specific info string |
| .RE |
| .sp |
| .RS 4 |
| .ie n \{\ |
| \h'-04'\(bu\h'+03'\c |
| .\} |
| .el \{\ |
| .sp -1 |
| .IP \(bu 2.3 |
| .\} |
| A list of enabled hooks |
| .RE |
| .sp |
| .RS 4 |
| .ie n \{\ |
| \h'-04'\(bu\h'+03'\c |
| .\} |
| .el \{\ |
| .sp -1 |
| .IP \(bu 2.3 |
| .\} |
| $SHELL |
| .RE |
| .sp |
| Additional information may be gathered into a separate zip archive using the \fB\-\-diagnose\fR option, and can be attached alongside the bugreport document to provide additional context to readers\&. |
| .sp |
| 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\&. |
| .SH "OPTIONS" |
| .PP |
| \-o <path>, \-\-output\-directory <path> |
| .RS 4 |
| Place the resulting bug report file in |
| \fB<path>\fR |
| instead of the current directory\&. |
| .RE |
| .PP |
| \-s <format>, \-\-suffix <format>, \-\-no\-suffix |
| .RS 4 |
| Specify an alternate suffix for the bugreport name, to create a file named |
| \fIgit\-bugreport\-<formatted\-suffix>\fR\&. This should take the form of a strftime(3) format string; the current local time will be used\&. |
| \fB\-\-no\-suffix\fR |
| disables the suffix and the file is just named |
| \fBgit\-bugreport\fR |
| without any disambiguation measure\&. |
| .RE |
| .PP |
| \-\-no\-diagnose, \-\-diagnose[=<mode>] |
| .RS 4 |
| Create a zip archive of supplemental information about the user\(cqs machine, Git client, and repository state\&. The archive is written to the same output directory as the bug report and is named |
| \fIgit\-diagnostics\-<formatted\-suffix>\fR\&. |
| .sp |
| Without |
| \fBmode\fR |
| specified, the diagnostic archive will contain the default set of statistics reported by |
| \fBgit diagnose\fR\&. An optional |
| \fBmode\fR |
| value may be specified to change which information is included in the archive\&. See |
| \fBgit-diagnose\fR(1) |
| for the list of valid values for |
| \fBmode\fR |
| and details about their usage\&. |
| .RE |
| .SH "GIT" |
| .sp |
| Part of the \fBgit\fR(1) suite |