logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

git-bugreport.1 (4594B)

    

  1. '\" t
  2. .\"     Title: git-bugreport
  3. .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
  4. .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
  5. .\"      Date: 2025-03-14
  6. .\"    Manual: Git Manual
  7. .\"    Source: Git 2.49.0
  8. .\"  Language: English
  9. .\"
  10. .TH "GIT\-BUGREPORT" "1" "2025-03-14" "Git 2\&.49\&.0" "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. .SH "DESCRIPTION"
  40. .sp
  41. 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\&.
  42. .sp
  43. The following information is requested from the user:
  44. .sp
  45. .RS 4
  46. .ie n \{\
  47. \h'-04'\(bu\h'+03'\c
  48. .\}
  49. .el \{\
  50. .sp -1
  51. .IP \(bu 2.3
  52. .\}
  53. Reproduction steps
  54. .RE
  55. .sp
  56. .RS 4
  57. .ie n \{\
  58. \h'-04'\(bu\h'+03'\c
  59. .\}
  60. .el \{\
  61. .sp -1
  62. .IP \(bu 2.3
  63. .\}
  64. Expected behavior
  65. .RE
  66. .sp
  67. .RS 4
  68. .ie n \{\
  69. \h'-04'\(bu\h'+03'\c
  70. .\}
  71. .el \{\
  72. .sp -1
  73. .IP \(bu 2.3
  74. .\}
  75. Actual behavior
  76. .RE
  77. .sp
  78. The following information is captured automatically:
  79. .sp
  80. .RS 4
  81. .ie n \{\
  82. \h'-04'\(bu\h'+03'\c
  83. .\}
  84. .el \{\
  85. .sp -1
  86. .IP \(bu 2.3
  87. .\}
  88. \fIgit version \-\-build\-options\fR
  89. .RE
  90. .sp
  91. .RS 4
  92. .ie n \{\
  93. \h'-04'\(bu\h'+03'\c
  94. .\}
  95. .el \{\
  96. .sp -1
  97. .IP \(bu 2.3
  98. .\}
  99. uname sysname, release, version, and machine strings
  100. .RE
  101. .sp
  102. .RS 4
  103. .ie n \{\
  104. \h'-04'\(bu\h'+03'\c
  105. .\}
  106. .el \{\
  107. .sp -1
  108. .IP \(bu 2.3
  109. .\}
  110. Compiler\-specific info string
  111. .RE
  112. .sp
  113. .RS 4
  114. .ie n \{\
  115. \h'-04'\(bu\h'+03'\c
  116. .\}
  117. .el \{\
  118. .sp -1
  119. .IP \(bu 2.3
  120. .\}
  121. A list of enabled hooks
  122. .RE
  123. .sp
  124. .RS 4
  125. .ie n \{\
  126. \h'-04'\(bu\h'+03'\c
  127. .\}
  128. .el \{\
  129. .sp -1
  130. .IP \(bu 2.3
  131. .\}
  132. $SHELL
  133. .RE
  134. .sp
  135. 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\&.
  136. .sp
  137. 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\&.
  138. .SH "OPTIONS"
  139. .PP
  140. \-o <path>, \-\-output\-directory <path>
  141. .RS 4
  142. Place the resulting bug report file in
  143. \fI<path>\fR
  144. instead of the current directory\&.
  145. .RE
  146. .PP
  147. \-s <format>, \-\-suffix <format>, \-\-no\-suffix
  148. .RS 4
  149. Specify an alternate suffix for the bugreport name, to create a file named
  150. \fIgit\-bugreport\-<formatted\-suffix>\fR\&. This should take the form of a strftime(3) format string; the current local time will be used\&.
  151. \fB\-\-no\-suffix\fR
  152. disables the suffix and the file is just named
  153. \fBgit\-bugreport\fR
  154. without any disambiguation measure\&.
  155. .RE
  156. .PP
  157. \-\-no\-diagnose, \-\-diagnose[=<mode>]
  158. .RS 4
  159. 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
  160. \fIgit\-diagnostics\-<formatted\-suffix>\fR\&.
  161. .sp
  162. Without
  163. \fBmode\fR
  164. specified, the diagnostic archive will contain the default set of statistics reported by
  165. \fBgit\fR
  166. \fBdiagnose\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