man1/git-bugreport.1

   1 '\" t
   2 .\"     Title: git-bugreport
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2024-05-28
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.45.1.313.g3a57aa566a
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-BUGREPORT" "1" "2024\-05\-28" "Git 2\&.45\&.1\&.313\&.g3a57aa" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-bugreport \- Collect information for user to file a bug report
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit bugreport\fR [(\-o | \-\-output\-directory) <path>]
  36                 [(\-s | \-\-suffix) <format> | \-\-no\-suffix]
  37                 [\-\-diagnose[=<mode>]]
  38 .fi
  39 .sp
  40 .SH "DESCRIPTION"
  41 .sp
  42 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\&.
  43 .sp
  44 The following information is requested from the user:
  45 .sp
  46 .RS 4
  47 .ie n \{\
  48 \h'-04'\(bu\h'+03'\c
  49 .\}
  50 .el \{\
  51 .sp -1
  52 .IP \(bu 2.3
  53 .\}
  54 Reproduction steps
  55 .RE
  56 .sp
  57 .RS 4
  58 .ie n \{\
  59 \h'-04'\(bu\h'+03'\c
  60 .\}
  61 .el \{\
  62 .sp -1
  63 .IP \(bu 2.3
  64 .\}
  65 Expected behavior
  66 .RE
  67 .sp
  68 .RS 4
  69 .ie n \{\
  70 \h'-04'\(bu\h'+03'\c
  71 .\}
  72 .el \{\
  73 .sp -1
  74 .IP \(bu 2.3
  75 .\}
  76 Actual behavior
  77 .RE
  78 .sp
  79 The following information is captured automatically:
  80 .sp
  81 .RS 4
  82 .ie n \{\
  83 \h'-04'\(bu\h'+03'\c
  84 .\}
  85 .el \{\
  86 .sp -1
  87 .IP \(bu 2.3
  88 .\}
  89 \fIgit version \-\-build\-options\fR
  90 .RE
  91 .sp
  92 .RS 4
  93 .ie n \{\
  94 \h'-04'\(bu\h'+03'\c
  95 .\}
  96 .el \{\
  97 .sp -1
  98 .IP \(bu 2.3
  99 .\}
 100 uname sysname, release, version, and machine strings
 101 .RE
 102 .sp
 103 .RS 4
 104 .ie n \{\
 105 \h'-04'\(bu\h'+03'\c
 106 .\}
 107 .el \{\
 108 .sp -1
 109 .IP \(bu 2.3
 110 .\}
 111 Compiler\-specific info string
 112 .RE
 113 .sp
 114 .RS 4
 115 .ie n \{\
 116 \h'-04'\(bu\h'+03'\c
 117 .\}
 118 .el \{\
 119 .sp -1
 120 .IP \(bu 2.3
 121 .\}
 122 A list of enabled hooks
 123 .RE
 124 .sp
 125 .RS 4
 126 .ie n \{\
 127 \h'-04'\(bu\h'+03'\c
 128 .\}
 129 .el \{\
 130 .sp -1
 131 .IP \(bu 2.3
 132 .\}
 133 $SHELL
 134 .RE
 135 .sp
 136 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\&.
 137 .sp
 138 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\&.
 139 .SH "OPTIONS"
 140 .PP
 141 \-o <path>, \-\-output\-directory <path>
 142 .RS 4
 143 Place the resulting bug report file in
 144 \fB<path>\fR
 145 instead of the current directory\&.
 146 .RE
 147 .PP
 148 \-s <format>, \-\-suffix <format>, \-\-no\-suffix
 149 .RS 4
 150 Specify an alternate suffix for the bugreport name, to create a file named
 151 \fIgit\-bugreport\-<formatted\-suffix>\fR\&. This should take the form of a strftime(3) format string; the current local time will be used\&.
 152 \fB\-\-no\-suffix\fR
 153 disables the suffix and the file is just named
 154 \fBgit\-bugreport\fR
 155 without any disambiguation measure\&.
 156 .RE
 157 .PP
 158 \-\-no\-diagnose, \-\-diagnose[=<mode>]
 159 .RS 4
 160 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
 161 \fIgit\-diagnostics\-<formatted\-suffix>\fR\&.
 162 .sp
 163 Without
 164 \fBmode\fR
 165 specified, the diagnostic archive will contain the default set of statistics reported by
 166 \fBgit diagnose\fR\&. An optional
 167 \fBmode\fR
 168 value may be specified to change which information is included in the archive\&. See
 169 \fBgit-diagnose\fR(1)
 170 for the list of valid values for
 171 \fBmode\fR
 172 and details about their usage\&.
 173 .RE
 174 .SH "GIT"
 175 .sp
 176 Part of the \fBgit\fR(1) suite