]>
Commit | Line | Data |
---|---|---|
238b439d ES |
1 | git-bugreport(1) |
2 | ================ | |
3 | ||
4 | NAME | |
5 | ---- | |
6 | git-bugreport - Collect information for user to file a bug report | |
7 | ||
8 | SYNOPSIS | |
9 | -------- | |
10 | [verse] | |
11 | 'git bugreport' [(-o | --output-directory) <path>] [(-s | --suffix) <format>] | |
12 | ||
13 | DESCRIPTION | |
14 | ----------- | |
15 | Captures information about the user's machine, Git client, and repository state, | |
16 | as well as a form requesting information about the behavior the user observed, | |
17 | into a single text file which the user can then share, for example to the Git | |
18 | mailing list, in order to report an observed bug. | |
19 | ||
20 | The following information is requested from the user: | |
21 | ||
22 | - Reproduction steps | |
23 | - Expected behavior | |
24 | - Actual behavior | |
25 | ||
617d5719 ES |
26 | The following information is captured automatically: |
27 | ||
28 | - 'git version --build-options' | |
1411914a | 29 | - uname sysname, release, version, and machine strings |
69bcbbce | 30 | - Compiler-specific info string |
788a7760 | 31 | - A list of enabled hooks |
4a4804ed | 32 | - $SHELL |
617d5719 | 33 | |
238b439d ES |
34 | This tool is invoked via the typical Git setup process, which means that in some |
35 | cases, it might not be able to launch - for example, if a relevant config file | |
36 | is unreadable. In this kind of scenario, it may be helpful to manually gather | |
37 | the kind of information listed above when manually asking for help. | |
38 | ||
39 | OPTIONS | |
40 | ------- | |
41 | -o <path>:: | |
42 | --output-directory <path>:: | |
43 | Place the resulting bug report file in `<path>` instead of the root of | |
44 | the Git repository. | |
45 | ||
46 | -s <format>:: | |
47 | --suffix <format>:: | |
48 | Specify an alternate suffix for the bugreport name, to create a file | |
49 | named 'git-bugreport-<formatted suffix>'. This should take the form of a | |
01b62aaf | 50 | strftime(3) format string; the current local time will be used. |
238b439d ES |
51 | |
52 | GIT | |
53 | --- | |
54 | Part of the linkgit:git[1] suite |