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
  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
  26 The following information is captured automatically:
  27
  28  - 'git version --build-options'
  29  - uname sysname, release, version, and machine strings
  30  - Compiler-specific info string
  31
  32 This tool is invoked via the typical Git setup process, which means that in some
  33 cases, it might not be able to launch - for example, if a relevant config file
  34 is unreadable. In this kind of scenario, it may be helpful to manually gather
  35 the kind of information listed above when manually asking for help.
  36
  37 OPTIONS
  38 -------
  39 -o <path>::
  40 --output-directory <path>::
  41         Place the resulting bug report file in `<path>` instead of the root of
  42         the Git repository.
  43
  44 -s <format>::
  45 --suffix <format>::
  46         Specify an alternate suffix for the bugreport name, to create a file
  47         named 'git-bugreport-<formatted suffix>'. This should take the form of a
  48         link:strftime[3] format string; the current local time will be used.
  49
  50 GIT
  51 ---
  52 Part of the linkgit:git[1] suite