1GIT-BUGREPORT(1)                  Git Manual                  GIT-BUGREPORT(1)
2
3
4

NAME

6       git-bugreport - Collect information for user to file a bug report
7

SYNOPSIS

9       git bugreport [(-o | --output-directory) <path>] [(-s | --suffix) <format>]
10                       [--diagnose[=<mode>]]
11

DESCRIPTION

13       Captures information about the user’s machine, Git client, and
14       repository state, as well as a form requesting information about the
15       behavior the user observed, into a single text file which the user can
16       then share, for example to the Git mailing list, in order to report an
17       observed bug.
18
19       The following information is requested from the user:
20
21       •   Reproduction steps
22
23       •   Expected behavior
24
25       •   Actual behavior
26
27       The following information is captured automatically:
28
29       •   git version --build-options
30
31       •   uname sysname, release, version, and machine strings
32
33       •   Compiler-specific info string
34
35       •   A list of enabled hooks
36
37       •   $SHELL
38
39       Additional information may be gathered into a separate zip archive
40       using the --diagnose option, and can be attached alongside the
41       bugreport document to provide additional context to readers.
42
43       This tool is invoked via the typical Git setup process, which means
44       that in some cases, it might not be able to launch - for example, if a
45       relevant config file is unreadable. In this kind of scenario, it may be
46       helpful to manually gather the kind of information listed above when
47       manually asking for help.
48

OPTIONS

50       -o <path>, --output-directory <path>
51           Place the resulting bug report file in <path> instead of the
52           current directory.
53
54       -s <format>, --suffix <format>
55           Specify an alternate suffix for the bugreport name, to create a
56           file named git-bugreport-<formatted suffix>. This should take the
57           form of a strftime(3) format string; the current local time will be
58           used.
59
60       --no-diagnose, --diagnose[=<mode>]
61           Create a zip archive of supplemental information about the user’s
62           machine, Git client, and repository state. The archive is written
63           to the same output directory as the bug report and is named
64           git-diagnostics-<formatted suffix>.
65
66           Without mode specified, the diagnostic archive will contain the
67           default set of statistics reported by git diagnose. An optional
68           mode value may be specified to change which information is included
69           in the archive. See git-diagnose(1) for the list of valid values
70           for mode and details about their usage.
71

GIT

73       Part of the git(1) suite
74
75
76
77Git 2.39.1                        2023-01-13                  GIT-BUGREPORT(1)
Impressum