diff options
Diffstat (limited to 'man1/git-bugreport.1')
| -rw-r--r-- | man1/git-bugreport.1 | 26 |
1 files changed, 23 insertions, 3 deletions
diff --git a/man1/git-bugreport.1 b/man1/git-bugreport.1 index f920329b6..3c0d0918a 100644 --- a/man1/git-bugreport.1 +++ b/man1/git-bugreport.1 @@ -2,12 +2,12 @@ .\" 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/18/2022 +.\" Date: 08/25/2022 .\" Manual: Git Manual -.\" Source: Git 2.37.2.382.g795ea8776b +.\" Source: Git 2.37.2.411.g7c46ea0ded .\" Language: English .\" -.TH "GIT\-BUGREPORT" "1" "08/18/2022" "Git 2\&.37\&.2\&.382\&.g795ea8" "Git Manual" +.TH "GIT\-BUGREPORT" "1" "08/25/2022" "Git 2\&.37\&.2\&.411\&.g7c46ea" "Git Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -33,6 +33,7 @@ git-bugreport \- Collect information for user to file a bug report .sp .nf \fIgit bugreport\fR [(\-o | \-\-output\-directory) <path>] [(\-s | \-\-suffix) <format>] + [\-\-diagnose[=<mode>]] .fi .sp .SH "DESCRIPTION" @@ -131,6 +132,8 @@ A list of enabled hooks $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 @@ -146,6 +149,23 @@ instead of the current directory\&. 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 +.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 |