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 v1.79.2 <http://docbook.sf.net/>
   5 .\"      Date: 2024-09-13
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.46.1.506.ged155187b4
   8 .\"  Language: English
   9 .\"
  10 .TH "GIT\-COMMIT\-GRAPH" "1" "2024-09-13" "Git 2\&.46\&.1\&.506\&.ged1551" "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 .SH "DESCRIPTION"
  42 .sp
  43 Manage the serialized commit\-graph file\&.
  44 .SH "OPTIONS"
  45 .PP
  46 \-\-object\-dir
  47 .RS 4
  48 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
  49 \fB\&.git\fR
  50 directory\&. The commit\-graph file is expected to be in the
  51 \fB<dir>/info\fR
  52 directory and the packfiles are expected to be in
  53 \fB<dir>/pack\fR\&. If the directory could not be made into an absolute path, or does not match any known object directory,
  54 \fBgit commit\-graph \&.\&.\&.\fR
  55 will exit with non\-zero status\&.
  56 .RE
  57 .PP
  58 \-\-[no\-]progress
  59 .RS 4
  60 Turn progress on/off explicitly\&. If neither is specified, progress is shown if standard error is connected to a terminal\&.
  61 .RE
  62 .SH "COMMANDS"
  63 .PP
  64 \fIwrite\fR
  65 .RS 4
  66 Write a commit\-graph file based on the commits found in packfiles\&. If the config option
  67 \fBcore\&.commitGraph\fR
  68 is disabled, then this command will output a warning, then return success without writing a commit\-graph file\&.
  69 .sp
  70 With the
  71 \fB\-\-stdin\-packs\fR
  72 option, generate the new commit graph by walking objects only in the specified pack\-indexes\&. (Cannot be combined with
  73 \fB\-\-stdin\-commits\fR
  74 or
  75 \fB\-\-reachable\fR\&.)
  76 .sp
  77 With the
  78 \fB\-\-stdin\-commits\fR
  79 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
  80 \fB\-\-stdin\-packs\fR
  81 or
  82 \fB\-\-reachable\fR\&.)
  83 .sp
  84 With the
  85 \fB\-\-reachable\fR
  86 option, generate the new commit graph by walking commits starting at all refs\&. (Cannot be combined with
  87 \fB\-\-stdin\-commits\fR
  88 or
  89 \fB\-\-stdin\-packs\fR\&.)
  90 .sp
  91 With the
  92 \fB\-\-append\fR
  93 option, include all commits that are present in the existing commit\-graph file\&.
  94 .sp
  95 With the
  96 \fB\-\-changed\-paths\fR
  97 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
  98 \fBgit log \-\- <path>\fR\&. If this option is given, future commit\-graph writes will automatically assume that this option was intended\&. Use
  99 \fB\-\-no\-changed\-paths\fR
 100 to stop storing this data\&.
 101 .sp
 102 With the
 103 \fB\-\-max\-new\-filters=<n>\fR
 104 option, generate at most
 105 \fBn\fR
 106 new Bloom filters (if
 107 \fB\-\-changed\-paths\fR
 108 is specified)\&. If
 109 \fBn\fR
 110 is
 111 \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
 112 \fB\-\-split=replace\fR\&. Overrides the
 113 \fBcommitGraph\&.maxNewFilters\fR
 114 configuration\&.
 115 .sp
 116 With the
 117 \fB\-\-split[=<strategy>]\fR
 118 option, write the commit\-graph as a chain of multiple commit\-graph files stored in
 119 \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:
 120 .sp
 121 .RS 4
 122 .ie n \{\
 123 \h'-04'\(bu\h'+03'\c
 124 .\}
 125 .el \{\
 126 .sp -1
 127 .IP \(bu 2.3
 128 .\}
 129 If
 130 \fB\-\-split=no\-merge\fR
 131 is specified, a merge is never performed, and the remaining options are ignored\&.
 132 \fB\-\-split=replace\fR
 133 overwrites the existing chain with a new one\&. A bare
 134 \fB\-\-split\fR
 135 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)\&.
 136 .RE
 137 .sp
 138 .RS 4
 139 .ie n \{\
 140 \h'-04'\(bu\h'+03'\c
 141 .\}
 142 .el \{\
 143 .sp -1
 144 .IP \(bu 2.3
 145 .\}
 146 If
 147 \fB\-\-size\-multiple=<X>\fR
 148 is not specified, let
 149 \fBX\fR
 150 equal 2\&. If the new tip file would have
 151 \fBN\fR
 152 commits and the previous tip has
 153 \fBM\fR
 154 commits and
 155 \fBX\fR
 156 times
 157 \fBN\fR
 158 is greater than
 159 \fBM\fR, instead merge the two files into a single file\&.
 160 .RE
 161 .sp
 162 .RS 4
 163 .ie n \{\
 164 \h'-04'\(bu\h'+03'\c
 165 .\}
 166 .el \{\
 167 .sp -1
 168 .IP \(bu 2.3
 169 .\}
 170 If
 171 \fB\-\-max\-commits=<M>\fR
 172 is specified with
 173 \fBM\fR
 174 a positive integer, and the new tip file would have more than
 175 \fBM\fR
 176 commits, then instead merge the new tip with the previous tip\&.
 177 .sp
 178 Finally, if
 179 \fB\-\-expire\-time=<datetime>\fR
 180 is not specified, let
 181 \fBdatetime\fR
 182 be the current time\&. After writing the split commit\-graph, delete all unused commit\-graph whose modified times are older than
 183 \fBdatetime\fR\&.
 184 .RE
 185 .RE
 186 .PP
 187 \fIverify\fR
 188 .RS 4
 189 Read the commit\-graph file and verify its contents against the object database\&. Used to check for corrupted data\&.
 190 .sp
 191 With the
 192 \fB\-\-shallow\fR
 193 option, only check the tip commit\-graph file in a chain of split commit\-graphs\&.
 194 .RE
 195 .SH "EXAMPLES"
 196 .sp
 197 .RS 4
 198 .ie n \{\
 199 \h'-04'\(bu\h'+03'\c
 200 .\}
 201 .el \{\
 202 .sp -1
 203 .IP \(bu 2.3
 204 .\}
 205 Write a commit\-graph file for the packed commits in your local
 206 \fB\&.git\fR
 207 directory\&.
 208 .sp
 209 .if n \{\
 210 .RS 4
 211 .\}
 212 .nf
 213 $ git commit\-graph write
 214 .fi
 215 .if n \{\
 216 .RE
 217 .\}
 218 .RE
 219 .sp
 220 .RS 4
 221 .ie n \{\
 222 \h'-04'\(bu\h'+03'\c
 223 .\}
 224 .el \{\
 225 .sp -1
 226 .IP \(bu 2.3
 227 .\}
 228 Write a commit\-graph file, extending the current commit\-graph file using commits in
 229 \fB<pack\-index>\fR\&.
 230 .sp
 231 .if n \{\
 232 .RS 4
 233 .\}
 234 .nf
 235 $ echo <pack\-index> | git commit\-graph write \-\-stdin\-packs
 236 .fi
 237 .if n \{\
 238 .RE
 239 .\}
 240 .RE
 241 .sp
 242 .RS 4
 243 .ie n \{\
 244 \h'-04'\(bu\h'+03'\c
 245 .\}
 246 .el \{\
 247 .sp -1
 248 .IP \(bu 2.3
 249 .\}
 250 Write a commit\-graph file containing all reachable commits\&.
 251 .sp
 252 .if n \{\
 253 .RS 4
 254 .\}
 255 .nf
 256 $ git show\-ref \-s | git commit\-graph write \-\-stdin\-commits
 257 .fi
 258 .if n \{\
 259 .RE
 260 .\}
 261 .RE
 262 .sp
 263 .RS 4
 264 .ie n \{\
 265 \h'-04'\(bu\h'+03'\c
 266 .\}
 267 .el \{\
 268 .sp -1
 269 .IP \(bu 2.3
 270 .\}
 271 Write a commit\-graph file containing all commits in the current commit\-graph file along with those reachable from
 272 \fBHEAD\fR\&.
 273 .sp
 274 .if n \{\
 275 .RS 4
 276 .\}
 277 .nf
 278 $ git rev\-parse HEAD | git commit\-graph write \-\-stdin\-commits \-\-append
 279 .fi
 280 .if n \{\
 281 .RE
 282 .\}
 283 .RE
 284 .SH "CONFIGURATION"
 285 .sp
 286 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:
 287 .PP
 288 commitGraph\&.generationVersion
 289 .RS 4
 290 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\&.
 291 .RE
 292 .PP
 293 commitGraph\&.maxNewFilters
 294 .RS 4
 295 Specifies the default value for the
 296 \fB\-\-max\-new\-filters\fR
 297 option of
 298 \fBgit commit\-graph write\fR
 299 (c\&.f\&.,
 300 \fBgit-commit-graph\fR(1))\&.
 301 .RE
 302 .PP
 303 commitGraph\&.readChangedPaths
 304 .RS 4
 305 Deprecated\&. Equivalent to commitGraph\&.changedPathsVersion=\-1 if true, and commitGraph\&.changedPathsVersion=0 if false\&. (If commitGraph\&.changedPathVersion is also set, commitGraph\&.changedPathsVersion takes precedence\&.)
 306 .RE
 307 .PP
 308 commitGraph\&.changedPathsVersion
 309 .RS 4
 310 Specifies the version of the changed\-path Bloom filters that Git will read and write\&. May be \-1, 0, 1, or 2\&. Note that values greater than 1 may be incompatible with older versions of Git which do not yet understand those versions\&. Use caution when operating in a mixed\-version environment\&.
 311 .sp
 312 Defaults to \-1\&.
 313 .sp
 314 If \-1, Git will use the version of the changed\-path Bloom filters in the repository, defaulting to 1 if there are none\&.
 315 .sp
 316 If 0, Git will not read any Bloom filters, and will write version 1 Bloom filters when instructed to write\&.
 317 .sp
 318 If 1, Git will only read version 1 Bloom filters, and will write version 1 Bloom filters\&.
 319 .sp
 320 If 2, Git will only read version 2 Bloom filters, and will write version 2 Bloom filters\&.
 321 .sp
 322 See
 323 \fBgit-commit-graph\fR(1)
 324 for more information\&.
 325 .RE
 326 .SH "FILE FORMAT"
 327 .sp
 328 see \fBgitformat-commit-graph\fR(5)\&.
 329 .SH "GIT"
 330 .sp
 331 Part of the \fBgit\fR(1) suite