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: 07/22/2022
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.37.1.223.g6a475b71f8
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-BUGREPORT" "1" "07/22/2022" "Git 2\&.37\&.1\&.223\&.g6a475b" "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>] [(\-s | \-\-suffix) <format>]
  36 .fi
  37 .sp
  38 .SH "DESCRIPTION"
  39 .sp
  40 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\&.
  41 .sp
  42 The following information is requested from the user:
  43 .sp
  44 .RS 4
  45 .ie n \{\
  46 \h'-04'\(bu\h'+03'\c
  47 .\}
  48 .el \{\
  49 .sp -1
  50 .IP \(bu 2.3
  51 .\}
  52 Reproduction steps
  53 .RE
  54 .sp
  55 .RS 4
  56 .ie n \{\
  57 \h'-04'\(bu\h'+03'\c
  58 .\}
  59 .el \{\
  60 .sp -1
  61 .IP \(bu 2.3
  62 .\}
  63 Expected behavior
  64 .RE
  65 .sp
  66 .RS 4
  67 .ie n \{\
  68 \h'-04'\(bu\h'+03'\c
  69 .\}
  70 .el \{\
  71 .sp -1
  72 .IP \(bu 2.3
  73 .\}
  74 Actual behavior
  75 .RE
  76 .sp
  77 The following information is captured automatically:
  78 .sp
  79 .RS 4
  80 .ie n \{\
  81 \h'-04'\(bu\h'+03'\c
  82 .\}
  83 .el \{\
  84 .sp -1
  85 .IP \(bu 2.3
  86 .\}
  87 \fIgit version \-\-build\-options\fR
  88 .RE
  89 .sp
  90 .RS 4
  91 .ie n \{\
  92 \h'-04'\(bu\h'+03'\c
  93 .\}
  94 .el \{\
  95 .sp -1
  96 .IP \(bu 2.3
  97 .\}
  98 uname sysname, release, version, and machine strings
  99 .RE
 100 .sp
 101 .RS 4
 102 .ie n \{\
 103 \h'-04'\(bu\h'+03'\c
 104 .\}
 105 .el \{\
 106 .sp -1
 107 .IP \(bu 2.3
 108 .\}
 109 Compiler\-specific info string
 110 .RE
 111 .sp
 112 .RS 4
 113 .ie n \{\
 114 \h'-04'\(bu\h'+03'\c
 115 .\}
 116 .el \{\
 117 .sp -1
 118 .IP \(bu 2.3
 119 .\}
 120 A list of enabled hooks
 121 .RE
 122 .sp
 123 .RS 4
 124 .ie n \{\
 125 \h'-04'\(bu\h'+03'\c
 126 .\}
 127 .el \{\
 128 .sp -1
 129 .IP \(bu 2.3
 130 .\}
 131 $SHELL
 132 .RE
 133 .sp
 134 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\&.
 135 .SH "OPTIONS"
 136 .PP
 137 \-o <path>, \-\-output\-directory <path>
 138 .RS 4
 139 Place the resulting bug report file in
 140 \fB<path>\fR
 141 instead of the current directory\&.
 142 .RE
 143 .PP
 144 \-s <format>, \-\-suffix <format>
 145 .RS 4
 146 Specify an alternate suffix for the bugreport name, to create a file named
 147 \fIgit\-bugreport\-<formatted suffix>\fR\&. This should take the form of a strftime(3) format string; the current local time will be used\&.
 148 .RE
 149 .SH "GIT"
 150 .sp
 151 Part of the \fBgit\fR(1) suite