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 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
  27 The following information is captured automatically:
  28
  29  - 'git version --build-options'
  30  - uname sysname, release, version, and machine strings
  31  - Compiler-specific info string
  32  - A list of enabled hooks
  33  - $SHELL
  34
  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
  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>::
  48         Place the resulting bug report file in `<path>` instead of the current
  49         directory.
  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
  55         strftime(3) format string; the current local time will be used.
  56
  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
  70 GIT
  71 ---
  72 Part of the linkgit:git[1] suite