| Emily Shaffer | 238b439 | 2020-04-16 14:18:04 -0700 | [diff] [blame] | 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>] |
| Victoria Dye | aac0e8f | 2022-08-12 20:10:17 +0000 | [diff] [blame] | 12 | [--diagnose[=<mode>]] |
| Emily Shaffer | 238b439 | 2020-04-16 14:18:04 -0700 | [diff] [blame] | 13 | |
| 14 | DESCRIPTION |
| 15 | ----------- |
| 16 | Captures information about the user's machine, Git client, and repository state, |
| 17 | as well as a form requesting information about the behavior the user observed, |
| 18 | into a single text file which the user can then share, for example to the Git |
| 19 | mailing list, in order to report an observed bug. |
| 20 | |
| 21 | The following information is requested from the user: |
| 22 | |
| 23 | - Reproduction steps |
| 24 | - Expected behavior |
| 25 | - Actual behavior |
| 26 | |
| Emily Shaffer | 617d571 | 2020-04-16 14:18:05 -0700 | [diff] [blame] | 27 | The following information is captured automatically: |
| 28 | |
| 29 | - 'git version --build-options' |
| Emily Shaffer | 1411914 | 2020-04-16 14:18:06 -0700 | [diff] [blame] | 30 | - uname sysname, release, version, and machine strings |
| Emily Shaffer | 69bcbbc | 2020-04-16 14:18:07 -0700 | [diff] [blame] | 31 | - Compiler-specific info string |
| Emily Shaffer | 788a776 | 2020-05-07 17:53:57 -0700 | [diff] [blame] | 32 | - A list of enabled hooks |
| Emily Shaffer | 4a4804e | 2020-05-12 16:42:13 -0700 | [diff] [blame] | 33 | - $SHELL |
| Emily Shaffer | 617d571 | 2020-04-16 14:18:05 -0700 | [diff] [blame] | 34 | |
| Victoria Dye | aac0e8f | 2022-08-12 20:10:17 +0000 | [diff] [blame] | 35 | Additional information may be gathered into a separate zip archive using the |
| 36 | `--diagnose` option, and can be attached alongside the bugreport document to |
| 37 | provide additional context to readers. |
| 38 | |
| Emily Shaffer | 238b439 | 2020-04-16 14:18:04 -0700 | [diff] [blame] | 39 | This tool is invoked via the typical Git setup process, which means that in some |
| 40 | cases, it might not be able to launch - for example, if a relevant config file |
| 41 | is unreadable. In this kind of scenario, it may be helpful to manually gather |
| 42 | the kind of information listed above when manually asking for help. |
| 43 | |
| 44 | OPTIONS |
| 45 | ------- |
| 46 | -o <path>:: |
| 47 | --output-directory <path>:: |
| Bagas Sanjaya | ca0cc98 | 2021-09-03 18:59:34 +0700 | [diff] [blame] | 48 | Place the resulting bug report file in `<path>` instead of the current |
| 49 | directory. |
| Emily Shaffer | 238b439 | 2020-04-16 14:18:04 -0700 | [diff] [blame] | 50 | |
| 51 | -s <format>:: |
| 52 | --suffix <format>:: |
| 53 | Specify an alternate suffix for the bugreport name, to create a file |
| 54 | named 'git-bugreport-<formatted suffix>'. This should take the form of a |
| Todd Zullinger | 01b62aa | 2020-05-18 15:37:36 -0400 | [diff] [blame] | 55 | strftime(3) format string; the current local time will be used. |
| Emily Shaffer | 238b439 | 2020-04-16 14:18:04 -0700 | [diff] [blame] | 56 | |
| Victoria Dye | aac0e8f | 2022-08-12 20:10:17 +0000 | [diff] [blame] | 57 | --no-diagnose:: |
| 58 | --diagnose[=<mode>]:: |
| 59 | Create a zip archive of supplemental information about the user's |
| 60 | machine, Git client, and repository state. The archive is written to the |
| 61 | same output directory as the bug report and is named |
| 62 | 'git-diagnostics-<formatted suffix>'. |
| 63 | + |
| 64 | Without `mode` specified, the diagnostic archive will contain the default set of |
| 65 | statistics reported by `git diagnose`. An optional `mode` value may be specified |
| 66 | to change which information is included in the archive. See |
| 67 | linkgit:git-diagnose[1] for the list of valid values for `mode` and details |
| 68 | about their usage. |
| 69 | |
| Emily Shaffer | 238b439 | 2020-04-16 14:18:04 -0700 | [diff] [blame] | 70 | GIT |
| 71 | --- |
| 72 | Part of the linkgit:git[1] suite |
