1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
'\" 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: 08/05/2022
.\" Manual: Git Manual
.\" Source: Git 2.37.1.377.g679aad9e82
.\" Language: English
.\"
.TH "GIT\-BUGREPORT" "1" "08/05/2022" "Git 2\&.37\&.1\&.377\&.g679aad" "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>]
.fi
.sp
.SH "DESCRIPTION"
.sp
Captures information about the user\(cqs 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\&.
.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
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>
.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\&.
.RE
.SH "GIT"
.sp
Part of the \fBgit\fR(1) suite
|
