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