Documentation/git-diagnose.txt

   1 git-diagnose(1)
   2 ================
   3
   4 NAME
   5 ----
   6 git-diagnose - Generate a zip archive of diagnostic information
   7
   8 SYNOPSIS
   9 --------
  10 [verse]
  11 'git diagnose' [(-o | --output-directory) <path>] [(-s | --suffix) <format>]
  12
  13 DESCRIPTION
  14 -----------
  15 Collects detailed information about the user's machine, Git client, and
  16 repository state and packages that information into a zip archive. The
  17 generated archive can then, for example, be shared with the Git mailing list to
  18 help debug an issue or serve as a reference for independent debugging.
  19
  20 The following information is captured in the archive:
  21
  22   * 'git version --build-options'
  23   * The path to the repository root
  24   * The available disk space on the filesystem
  25   * The name and size of each packfile, including those in alternate object
  26     stores
  27   * The total count of loose objects, as well as counts broken down by
  28     `.git/objects` subdirectory
  29
  30 This tool differs from linkgit:git-bugreport[1] in that it collects much more
  31 detailed information with a greater focus on reporting the size and data shape
  32 of repository contents.
  33
  34 OPTIONS
  35 -------
  36 -o <path>::
  37 --output-directory <path>::
  38         Place the resulting diagnostics archive in `<path>` instead of the
  39         current directory.
  40
  41 -s <format>::
  42 --suffix <format>::
  43         Specify an alternate suffix for the diagnostics archive name, to create
  44         a file named 'git-diagnostics-<formatted suffix>'. This should take the
  45         form of a strftime(3) format string; the current local time will be
  46         used.
  47
  48 GIT
  49 ---
  50 Part of the linkgit:git[1] suite