Documentation/git-bugreport.txt

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