projects / thirdparty / git.git / blame
| 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] | |
| b3b57c69 JS |
11 | 'git bugreport' [(-o | --output-directory) <path>] |
| 12 | [(-s | --suffix) <format> | --no-suffix] | |
| aac0e8ff | 13 | [--diagnose[=<mode>]] |
| 238b439d ES |
14 | |
| 15 | DESCRIPTION | |
| 16 | ----------- | |
| cf6cac20 EN |
17 | Collects information about the user's machine, Git client, and repository |
| 18 | state, in addition to a form requesting information about the behavior the | |
| 19 | user observed, and stores it in a single text file which the user can then | |
| 20 | share, for example to the Git mailing list, in order to report an observed | |
| 21 | bug. | |
| 238b439d ES |
22 | |
| 23 | The following information is requested from the user: | |
| 24 | ||
| 25 | - Reproduction steps | |
| 26 | - Expected behavior | |
| 27 | - Actual behavior | |
| 28 | ||
| 617d5719 ES |
29 | The following information is captured automatically: |
| 30 | ||
| 31 | - 'git version --build-options' | |
| 1411914a | 32 | - uname sysname, release, version, and machine strings |
| 69bcbbce | 33 | - Compiler-specific info string |
| 788a7760 | 34 | - A list of enabled hooks |
| 4a4804ed | 35 | - $SHELL |
| 617d5719 | 36 | |
| aac0e8ff VD |
37 | Additional information may be gathered into a separate zip archive using the |
| 38 | `--diagnose` option, and can be attached alongside the bugreport document to | |
| 39 | provide additional context to readers. | |
| 40 | ||
| 238b439d ES |
41 | This tool is invoked via the typical Git setup process, which means that in some |
| 42 | cases, it might not be able to launch - for example, if a relevant config file | |
| 43 | is unreadable. In this kind of scenario, it may be helpful to manually gather | |
| 44 | the kind of information listed above when manually asking for help. | |
| 45 | ||
| 46 | OPTIONS | |
| 47 | ------- | |
| 48 | -o <path>:: | |
| 49 | --output-directory <path>:: | |
| ca0cc98e BS |
50 | Place the resulting bug report file in `<path>` instead of the current |
| 51 | directory. | |
| 238b439d ES |
52 | |
| 53 | -s <format>:: | |
| 54 | --suffix <format>:: | |
| b3b57c69 | 55 | --no-suffix:: |
| 238b439d | 56 | Specify an alternate suffix for the bugreport name, to create a file |
| 2162f9f6 | 57 | named 'git-bugreport-<formatted-suffix>'. This should take the form of a |
| 01b62aaf | 58 | strftime(3) format string; the current local time will be used. |
| b3b57c69 JS |
59 | `--no-suffix` disables the suffix and the file is just named |
| 60 | `git-bugreport` without any disambiguation measure. | |
| 238b439d | 61 | |
| aac0e8ff VD |
62 | --no-diagnose:: |
| 63 | --diagnose[=<mode>]:: | |
| 64 | Create a zip archive of supplemental information about the user's | |
| 65 | machine, Git client, and repository state. The archive is written to the | |
| 66 | same output directory as the bug report and is named | |
| 2162f9f6 | 67 | 'git-diagnostics-<formatted-suffix>'. |
| aac0e8ff VD |
68 | + |
| 69 | Without `mode` specified, the diagnostic archive will contain the default set of | |
| 70 | statistics reported by `git diagnose`. An optional `mode` value may be specified | |
| 71 | to change which information is included in the archive. See | |
| 72 | linkgit:git-diagnose[1] for the list of valid values for `mode` and details | |
| 73 | about their usage. | |
| 74 | ||
| 238b439d ES |
75 | GIT |
| 76 | --- | |
| 77 | Part of the linkgit:git[1] suite |