man1/git-commit-graph.1

   1 '\" t
   2 .\"     Title: git-commit-graph
   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-05-17
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.41.0.rc0.4.g004e0f790f
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-COMMIT\-GRAPH" "1" "2023\-05\-17" "Git 2\&.41\&.0\&.rc0\&.4\&.g00" "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-commit-graph \- Write and verify Git commit\-graph files
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \fIgit commit\-graph verify\fR [\-\-object\-dir <dir>] [\-\-shallow] [\-\-[no\-]progress]
  36 \fIgit commit\-graph write\fR [\-\-object\-dir <dir>] [\-\-append]
  37                         [\-\-split[=<strategy>]] [\-\-reachable | \-\-stdin\-packs | \-\-stdin\-commits]
  38                         [\-\-changed\-paths] [\-\-[no\-]max\-new\-filters <n>] [\-\-[no\-]progress]
  39                         <split options>
  40 .fi
  41 .sp
  42 .SH "DESCRIPTION"
  43 .sp
  44 Manage the serialized commit\-graph file\&.
  45 .SH "OPTIONS"
  46 .PP
  47 \-\-object\-dir
  48 .RS 4
  49 Use given directory for the location of packfiles and commit\-graph file\&. This parameter exists to specify the location of an alternate that only has the objects directory, not a full
  50 \fB\&.git\fR
  51 directory\&. The commit\-graph file is expected to be in the
  52 \fB<dir>/info\fR
  53 directory and the packfiles are expected to be in
  54 \fB<dir>/pack\fR\&. If the directory could not be made into an absolute path, or does not match any known object directory,
  55 \fBgit commit\-graph \&.\&.\&.\fR
  56 will exit with non\-zero status\&.
  57 .RE
  58 .PP
  59 \-\-[no\-]progress
  60 .RS 4
  61 Turn progress on/off explicitly\&. If neither is specified, progress is shown if standard error is connected to a terminal\&.
  62 .RE
  63 .SH "COMMANDS"
  64 .PP
  65 \fIwrite\fR
  66 .RS 4
  67 Write a commit\-graph file based on the commits found in packfiles\&. If the config option
  68 \fBcore\&.commitGraph\fR
  69 is disabled, then this command will output a warning, then return success without writing a commit\-graph file\&.
  70 .sp
  71 With the
  72 \fB\-\-stdin\-packs\fR
  73 option, generate the new commit graph by walking objects only in the specified pack\-indexes\&. (Cannot be combined with
  74 \fB\-\-stdin\-commits\fR
  75 or
  76 \fB\-\-reachable\fR\&.)
  77 .sp
  78 With the
  79 \fB\-\-stdin\-commits\fR
  80 option, generate the new commit graph by walking commits starting at the commits specified in stdin as a list of OIDs in hex, one OID per line\&. OIDs that resolve to non\-commits (either directly, or by peeling tags) are silently ignored\&. OIDs that are malformed, or do not exist generate an error\&. (Cannot be combined with
  81 \fB\-\-stdin\-packs\fR
  82 or
  83 \fB\-\-reachable\fR\&.)
  84 .sp
  85 With the
  86 \fB\-\-reachable\fR
  87 option, generate the new commit graph by walking commits starting at all refs\&. (Cannot be combined with
  88 \fB\-\-stdin\-commits\fR
  89 or
  90 \fB\-\-stdin\-packs\fR\&.)
  91 .sp
  92 With the
  93 \fB\-\-append\fR
  94 option, include all commits that are present in the existing commit\-graph file\&.
  95 .sp
  96 With the
  97 \fB\-\-changed\-paths\fR
  98 option, compute and write information about the paths changed between a commit and its first parent\&. This operation can take a while on large repositories\&. It provides significant performance gains for getting history of a directory or a file with
  99 \fBgit log \-\- <path>\fR\&. If this option is given, future commit\-graph writes will automatically assume that this option was intended\&. Use
 100 \fB\-\-no\-changed\-paths\fR
 101 to stop storing this data\&.
 102 .sp
 103 With the
 104 \fB\-\-max\-new\-filters=<n>\fR
 105 option, generate at most
 106 \fBn\fR
 107 new Bloom filters (if
 108 \fB\-\-changed\-paths\fR
 109 is specified)\&. If
 110 \fBn\fR
 111 is
 112 \fB\-1\fR, no limit is enforced\&. Only commits present in the new layer count against this limit\&. To retroactively compute Bloom filters over earlier layers, it is advised to use
 113 \fB\-\-split=replace\fR\&. Overrides the
 114 \fBcommitGraph\&.maxNewFilters\fR
 115 configuration\&.
 116 .sp
 117 With the
 118 \fB\-\-split[=<strategy>]\fR
 119 option, write the commit\-graph as a chain of multiple commit\-graph files stored in
 120 \fB<dir>/info/commit\-graphs\fR\&. Commit\-graph layers are merged based on the strategy and other splitting options\&. The new commits not already in the commit\-graph are added in a new "tip" file\&. This file is merged with the existing file if the following merge conditions are met:
 121 .sp
 122 .RS 4
 123 .ie n \{\
 124 \h'-04'\(bu\h'+03'\c
 125 .\}
 126 .el \{\
 127 .sp -1
 128 .IP \(bu 2.3
 129 .\}
 130 If
 131 \fB\-\-split=no\-merge\fR
 132 is specified, a merge is never performed, and the remaining options are ignored\&.
 133 \fB\-\-split=replace\fR
 134 overwrites the existing chain with a new one\&. A bare
 135 \fB\-\-split\fR
 136 defers to the remaining options\&. (Note that merging a chain of commit graphs replaces the existing chain with a length\-1 chain where the first and only incremental holds the entire graph)\&.
 137 .RE
 138 .sp
 139 .RS 4
 140 .ie n \{\
 141 \h'-04'\(bu\h'+03'\c
 142 .\}
 143 .el \{\
 144 .sp -1
 145 .IP \(bu 2.3
 146 .\}
 147 If
 148 \fB\-\-size\-multiple=<X>\fR
 149 is not specified, let
 150 \fBX\fR
 151 equal 2\&. If the new tip file would have
 152 \fBN\fR
 153 commits and the previous tip has
 154 \fBM\fR
 155 commits and
 156 \fBX\fR
 157 times
 158 \fBN\fR
 159 is greater than
 160 \fBM\fR, instead merge the two files into a single file\&.
 161 .RE
 162 .sp
 163 .RS 4
 164 .ie n \{\
 165 \h'-04'\(bu\h'+03'\c
 166 .\}
 167 .el \{\
 168 .sp -1
 169 .IP \(bu 2.3
 170 .\}
 171 If
 172 \fB\-\-max\-commits=<M>\fR
 173 is specified with
 174 \fBM\fR
 175 a positive integer, and the new tip file would have more than
 176 \fBM\fR
 177 commits, then instead merge the new tip with the previous tip\&.
 178 .sp
 179 Finally, if
 180 \fB\-\-expire\-time=<datetime>\fR
 181 is not specified, let
 182 \fBdatetime\fR
 183 be the current time\&. After writing the split commit\-graph, delete all unused commit\-graph whose modified times are older than
 184 \fBdatetime\fR\&.
 185 .RE
 186 .RE
 187 .PP
 188 \fIverify\fR
 189 .RS 4
 190 Read the commit\-graph file and verify its contents against the object database\&. Used to check for corrupted data\&.
 191 .sp
 192 With the
 193 \fB\-\-shallow\fR
 194 option, only check the tip commit\-graph file in a chain of split commit\-graphs\&.
 195 .RE
 196 .SH "EXAMPLES"
 197 .sp
 198 .RS 4
 199 .ie n \{\
 200 \h'-04'\(bu\h'+03'\c
 201 .\}
 202 .el \{\
 203 .sp -1
 204 .IP \(bu 2.3
 205 .\}
 206 Write a commit\-graph file for the packed commits in your local
 207 \fB\&.git\fR
 208 directory\&.
 209 .sp
 210 .if n \{\
 211 .RS 4
 212 .\}
 213 .nf
 214 $ git commit\-graph write
 215 .fi
 216 .if n \{\
 217 .RE
 218 .\}
 219 .sp
 220 .RE
 221 .sp
 222 .RS 4
 223 .ie n \{\
 224 \h'-04'\(bu\h'+03'\c
 225 .\}
 226 .el \{\
 227 .sp -1
 228 .IP \(bu 2.3
 229 .\}
 230 Write a commit\-graph file, extending the current commit\-graph file using commits in
 231 \fB<pack\-index>\fR\&.
 232 .sp
 233 .if n \{\
 234 .RS 4
 235 .\}
 236 .nf
 237 $ echo <pack\-index> | git commit\-graph write \-\-stdin\-packs
 238 .fi
 239 .if n \{\
 240 .RE
 241 .\}
 242 .sp
 243 .RE
 244 .sp
 245 .RS 4
 246 .ie n \{\
 247 \h'-04'\(bu\h'+03'\c
 248 .\}
 249 .el \{\
 250 .sp -1
 251 .IP \(bu 2.3
 252 .\}
 253 Write a commit\-graph file containing all reachable commits\&.
 254 .sp
 255 .if n \{\
 256 .RS 4
 257 .\}
 258 .nf
 259 $ git show\-ref \-s | git commit\-graph write \-\-stdin\-commits
 260 .fi
 261 .if n \{\
 262 .RE
 263 .\}
 264 .sp
 265 .RE
 266 .sp
 267 .RS 4
 268 .ie n \{\
 269 \h'-04'\(bu\h'+03'\c
 270 .\}
 271 .el \{\
 272 .sp -1
 273 .IP \(bu 2.3
 274 .\}
 275 Write a commit\-graph file containing all commits in the current commit\-graph file along with those reachable from
 276 \fBHEAD\fR\&.
 277 .sp
 278 .if n \{\
 279 .RS 4
 280 .\}
 281 .nf
 282 $ git rev\-parse HEAD | git commit\-graph write \-\-stdin\-commits \-\-append
 283 .fi
 284 .if n \{\
 285 .RE
 286 .\}
 287 .sp
 288 .RE
 289 .SH "CONFIGURATION"
 290 .sp
 291 Everything below this line in this section is selectively included from the \fBgit-config\fR(1) documentation\&. The content is the same as what\(cqs found there:
 292 .PP
 293 commitGraph\&.generationVersion
 294 .RS 4
 295 Specifies the type of generation number version to use when writing or reading the commit\-graph file\&. If version 1 is specified, then the corrected commit dates will not be written or read\&. Defaults to 2\&.
 296 .RE
 297 .PP
 298 commitGraph\&.maxNewFilters
 299 .RS 4
 300 Specifies the default value for the
 301 \fB\-\-max\-new\-filters\fR
 302 option of
 303 \fBgit commit\-graph write\fR
 304 (c\&.f\&.,
 305 \fBgit-commit-graph\fR(1))\&.
 306 .RE
 307 .PP
 308 commitGraph\&.readChangedPaths
 309 .RS 4
 310 If true, then git will use the changed\-path Bloom filters in the commit\-graph file (if it exists, and they are present)\&. Defaults to true\&. See
 311 \fBgit-commit-graph\fR(1)
 312 for more information\&.
 313 .RE
 314 .SH "FILE FORMAT"
 315 .sp
 316 see \fBgitformat-commit-graph\fR(5)\&.
 317 .SH "GIT"
 318 .sp
 319 Part of the \fBgit\fR(1) suite