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 vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2023-08-09
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.42.0.rc1
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-DIAGNOSE" "1" "2023\-08\-09" "Git 2\&.42\&.0\&.rc1" "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 .sp
  39 .SH "DESCRIPTION"
  40 .sp
  41 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\&.
  42 .sp
  43 By default, the following information is captured in the archive:
  44 .sp
  45 .RS 4
  46 .ie n \{\
  47 \h'-04'\(bu\h'+03'\c
  48 .\}
  49 .el \{\
  50 .sp -1
  51 .IP \(bu 2.3
  52 .\}
  53 \fIgit version \-\-build\-options\fR
  54 .RE
  55 .sp
  56 .RS 4
  57 .ie n \{\
  58 \h'-04'\(bu\h'+03'\c
  59 .\}
  60 .el \{\
  61 .sp -1
  62 .IP \(bu 2.3
  63 .\}
  64 The path to the repository root
  65 .RE
  66 .sp
  67 .RS 4
  68 .ie n \{\
  69 \h'-04'\(bu\h'+03'\c
  70 .\}
  71 .el \{\
  72 .sp -1
  73 .IP \(bu 2.3
  74 .\}
  75 The available disk space on the filesystem
  76 .RE
  77 .sp
  78 .RS 4
  79 .ie n \{\
  80 \h'-04'\(bu\h'+03'\c
  81 .\}
  82 .el \{\
  83 .sp -1
  84 .IP \(bu 2.3
  85 .\}
  86 The name and size of each packfile, including those in alternate object stores
  87 .RE
  88 .sp
  89 .RS 4
  90 .ie n \{\
  91 \h'-04'\(bu\h'+03'\c
  92 .\}
  93 .el \{\
  94 .sp -1
  95 .IP \(bu 2.3
  96 .\}
  97 The total count of loose objects, as well as counts broken down by
  98 \fB\&.git/objects\fR
  99 subdirectory
 100 .RE
 101 .sp
 102 Additional information can be collected by selecting a different diagnostic mode using the \fB\-\-mode\fR option\&.
 103 .sp
 104 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\&.
 105 .SH "OPTIONS"
 106 .PP
 107 \-o <path>, \-\-output\-directory <path>
 108 .RS 4
 109 Place the resulting diagnostics archive in
 110 \fB<path>\fR
 111 instead of the current directory\&.
 112 .RE
 113 .PP
 114 \-s <format>, \-\-suffix <format>
 115 .RS 4
 116 Specify an alternate suffix for the diagnostics archive name, to create a file named
 117 \fIgit\-diagnostics\-<formatted suffix>\fR\&. This should take the form of a strftime(3) format string; the current local time will be used\&.
 118 .RE
 119 .PP
 120 \-\-mode=(stats|all)
 121 .RS 4
 122 Specify the type of diagnostics that should be collected\&. The default behavior of
 123 \fIgit diagnose\fR
 124 is equivalent to
 125 \fB\-\-mode=stats\fR\&.
 126 .sp
 127 The
 128 \fB\-\-mode=all\fR
 129 option collects everything included in
 130 \fB\-\-mode=stats\fR, as well as copies of
 131 \fB\&.git\fR,
 132 \fB\&.git/hooks\fR,
 133 \fB\&.git/info\fR,
 134 \fB\&.git/logs\fR, and
 135 \fB\&.git/objects/info\fR
 136 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
 137 \fB\-\-mode=all\fR\&.
 138 .RE
 139 .SH "GIT"
 140 .sp
 141 Part of the \fBgit\fR(1) suite