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: 2024-09-20
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.46.1.603.g94b60adee3
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-DIAGNOSE" "1" "2024-09-20" "Git 2\&.46\&.1\&.603\&.g94b60a" "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
  97 \fB\&.git/objects\fR
  98 subdirectory
  99 .RE
 100 .sp
 101 Additional information can be collected by selecting a different diagnostic mode using the \fB\-\-mode\fR option\&.
 102 .sp
 103 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\&.
 104 .SH "OPTIONS"
 105 .PP
 106 \-o <path>, \-\-output\-directory <path>
 107 .RS 4
 108 Place the resulting diagnostics archive in
 109 \fB<path>\fR
 110 instead of the current directory\&.
 111 .RE
 112 .PP
 113 \-s <format>, \-\-suffix <format>
 114 .RS 4
 115 Specify an alternate suffix for the diagnostics archive name, to create a file named
 116 \fIgit\-diagnostics\-<formatted\-suffix>\fR\&. This should take the form of a strftime(3) format string; the current local time will be used\&.
 117 .RE
 118 .PP
 119 \-\-mode=(stats|all)
 120 .RS 4
 121 Specify the type of diagnostics that should be collected\&. The default behavior of
 122 \fIgit diagnose\fR
 123 is equivalent to
 124 \fB\-\-mode=stats\fR\&.
 125 .sp
 126 The
 127 \fB\-\-mode=all\fR
 128 option collects everything included in
 129 \fB\-\-mode=stats\fR, as well as copies of
 130 \fB\&.git\fR,
 131 \fB\&.git/hooks\fR,
 132 \fB\&.git/info\fR,
 133 \fB\&.git/logs\fR, and
 134 \fB\&.git/objects/info\fR
 135 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
 136 \fB\-\-mode=all\fR\&.
 137 .RE
 138 .SH "GIT"
 139 .sp
 140 Part of the \fBgit\fR(1) suite