man1/git-diagnose.1

   1 '\" t
   2 .\"     Title: git-diagnose
   3 .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
   5 .\"      Date: 2025-01-29
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.48.1.157.g3b0d05c4a7
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-DIAGNOSE" "1" "2025-01-29" "Git 2\&.48\&.1\&.157\&.g3b0d05" "Git Manual"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 git-diagnose \- Generate a zip archive of diagnostic information
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit diagnose\fR [(\-o | \-\-output\-directory) <path>] [(\-s | \-\-suffix) <format>]
  36                [\-\-mode=<mode>]
  37 .fi
  38 .SH "DESCRIPTION"
  39 .sp
  40 Collects detailed information about the user\(cqs machine, Git client, and repository state and packages that information into a zip archive\&. The generated archive can then, for example, be shared with the Git mailing list to help debug an issue or serve as a reference for independent debugging\&.
  41 .sp
  42 By default, the following information is captured in the archive:
  43 .sp
  44 .RS 4
  45 .ie n \{\
  46 \h'-04'\(bu\h'+03'\c
  47 .\}
  48 .el \{\
  49 .sp -1
  50 .IP \(bu 2.3
  51 .\}
  52 \fIgit version \-\-build\-options\fR
  53 .RE
  54 .sp
  55 .RS 4
  56 .ie n \{\
  57 \h'-04'\(bu\h'+03'\c
  58 .\}
  59 .el \{\
  60 .sp -1
  61 .IP \(bu 2.3
  62 .\}
  63 The path to the repository root
  64 .RE
  65 .sp
  66 .RS 4
  67 .ie n \{\
  68 \h'-04'\(bu\h'+03'\c
  69 .\}
  70 .el \{\
  71 .sp -1
  72 .IP \(bu 2.3
  73 .\}
  74 The available disk space on the filesystem
  75 .RE
  76 .sp
  77 .RS 4
  78 .ie n \{\
  79 \h'-04'\(bu\h'+03'\c
  80 .\}
  81 .el \{\
  82 .sp -1
  83 .IP \(bu 2.3
  84 .\}
  85 The name and size of each packfile, including those in alternate object stores
  86 .RE
  87 .sp
  88 .RS 4
  89 .ie n \{\
  90 \h'-04'\(bu\h'+03'\c
  91 .\}
  92 .el \{\
  93 .sp -1
  94 .IP \(bu 2.3
  95 .\}
  96 The total count of loose objects, as well as counts broken down by \&.\fBgit/objects\fR
  97 subdirectory
  98 .RE
  99 .sp
 100 Additional information can be collected by selecting a different diagnostic mode using the \fB\-\-mode\fR option\&.
 101 .sp
 102 This tool differs from \fBgit-bugreport\fR(1) in that it collects much more detailed information with a greater focus on reporting the size and data shape of repository contents\&.
 103 .SH "OPTIONS"
 104 .PP
 105 \-o <path>, \-\-output\-directory <path>
 106 .RS 4
 107 Place the resulting diagnostics archive in
 108 \fI<path>\fR
 109 instead of the current directory\&.
 110 .RE
 111 .PP
 112 \-s <format>, \-\-suffix <format>
 113 .RS 4
 114 Specify an alternate suffix for the diagnostics archive name, to create a file named
 115 \fIgit\-diagnostics\-<formatted\-suffix>\fR\&. This should take the form of a strftime(3) format string; the current local time will be used\&.
 116 .RE
 117 .PP
 118 \-\-mode=(stats|all)
 119 .RS 4
 120 Specify the type of diagnostics that should be collected\&. The default behavior of
 121 \fIgit diagnose\fR
 122 is equivalent to
 123 \fB\-\-mode=stats\fR\&.
 124 .sp
 125 The
 126 \fB\-\-mode=all\fR
 127 option collects everything included in
 128 \fB\-\-mode=stats\fR, as well as copies of \&.\fBgit\fR, \&.\fBgit/hooks\fR, \&.\fBgit/info\fR, \&.\fBgit/logs\fR, and \&.\fBgit/objects/info\fR
 129 directories\&. This additional information may be sensitive, as it can be used to reconstruct the full contents of the diagnosed repository\&. Users should exercise caution when sharing an archive generated with
 130 \fB\-\-mode=all\fR\&.
 131 .RE
 132 .SH "GIT"
 133 .sp
 134 Part of the \fBgit\fR(1) suite