Documentation/git-commit-graph.txt

   1 git-commit-graph(1)
   2 ===================
   3
   4 NAME
   5 ----
   6 git-commit-graph - Write and verify Git commit-graph files
   7
   8
   9 SYNOPSIS
  10 --------
  11 [verse]
  12 'git commit-graph verify' [--object-dir <dir>] [--shallow] [--[no-]progress]
  13 'git commit-graph write' <options> [--object-dir <dir>] [--[no-]progress]
  14
  15
  16 DESCRIPTION
  17 -----------
  18
  19 Manage the serialized commit-graph file.
  20
  21
  22 OPTIONS
  23 -------
  24 --object-dir::
  25         Use given directory for the location of packfiles and commit-graph
  26         file. This parameter exists to specify the location of an alternate
  27         that only has the objects directory, not a full `.git` directory. The
  28         commit-graph file is expected to be in the `<dir>/info` directory and
  29         the packfiles are expected to be in `<dir>/pack`. If the directory
  30         could not be made into an absolute path, or does not match any known
  31         object directory, `git commit-graph ...` will exit with non-zero
  32         status.
  33
  34 --[no-]progress::
  35         Turn progress on/off explicitly. If neither is specified, progress is
  36         shown if standard error is connected to a terminal.
  37
  38 COMMANDS
  39 --------
  40 'write'::
  41
  42 Write a commit-graph file based on the commits found in packfiles. If
  43 the config option `core.commitGraph` is disabled, then this command will
  44 output a warning, then return success without writing a commit-graph file.
  45 +
  46 With the `--stdin-packs` option, generate the new commit graph by
  47 walking objects only in the specified pack-indexes. (Cannot be combined
  48 with `--stdin-commits` or `--reachable`.)
  49 +
  50 With the `--stdin-commits` option, generate the new commit graph by
  51 walking commits starting at the commits specified in stdin as a list
  52 of OIDs in hex, one OID per line. OIDs that resolve to non-commits
  53 (either directly, or by peeling tags) are silently ignored. OIDs that
  54 are malformed, or do not exist generate an error. (Cannot be combined
  55 with `--stdin-packs` or `--reachable`.)
  56 +
  57 With the `--reachable` option, generate the new commit graph by walking
  58 commits starting at all refs. (Cannot be combined with `--stdin-commits`
  59 or `--stdin-packs`.)
  60 +
  61 With the `--append` option, include all commits that are present in the
  62 existing commit-graph file.
  63 +
  64 With the `--changed-paths` option, compute and write information about the
  65 paths changed between a commit and its first parent. This operation can
  66 take a while on large repositories. It provides significant performance gains
  67 for getting history of a directory or a file with `git log -- <path>`. If
  68 this option is given, future commit-graph writes will automatically assume
  69 that this option was intended. Use `--no-changed-paths` to stop storing this
  70 data.
  71 +
  72 With the `--max-new-filters=<n>` option, generate at most `n` new Bloom
  73 filters (if `--changed-paths` is specified). If `n` is `-1`, no limit is
  74 enforced. Only commits present in the new layer count against this
  75 limit. To retroactively compute Bloom filters over earlier layers, it is
  76 advised to use `--split=replace`.  Overrides the `commitGraph.maxNewFilters`
  77 configuration.
  78 +
  79 With the `--split[=<strategy>]` option, write the commit-graph as a
  80 chain of multiple commit-graph files stored in
  81 `<dir>/info/commit-graphs`. Commit-graph layers are merged based on the
  82 strategy and other splitting options. The new commits not already in the
  83 commit-graph are added in a new "tip" file. This file is merged with the
  84 existing file if the following merge conditions are met:
  85 +
  86 * If `--split=no-merge` is specified, a merge is never performed, and
  87 the remaining options are ignored. `--split=replace` overwrites the
  88 existing chain with a new one. A bare `--split` defers to the remaining
  89 options. (Note that merging a chain of commit graphs replaces the
  90 existing chain with a length-1 chain where the first and only
  91 incremental holds the entire graph).
  92 +
  93 * If `--size-multiple=<X>` is not specified, let `X` equal 2. If the new
  94 tip file would have `N` commits and the previous tip has `M` commits and
  95 `X` times `N` is greater than  `M`, instead merge the two files into a
  96 single file.
  97 +
  98 * If `--max-commits=<M>` is specified with `M` a positive integer, and the
  99 new tip file would have more than `M` commits, then instead merge the new
 100 tip with the previous tip.
 101 +
 102 Finally, if `--expire-time=<datetime>` is not specified, let `datetime`
 103 be the current time. After writing the split commit-graph, delete all
 104 unused commit-graph whose modified times are older than `datetime`.
 105
 106 'verify'::
 107
 108 Read the commit-graph file and verify its contents against the object
 109 database. Used to check for corrupted data.
 110 +
 111 With the `--shallow` option, only check the tip commit-graph file in
 112 a chain of split commit-graphs.
 113
 114
 115 EXAMPLES
 116 --------
 117
 118 * Write a commit-graph file for the packed commits in your local `.git`
 119   directory.
 120 +
 121 ------------------------------------------------
 122 $ git commit-graph write
 123 ------------------------------------------------
 124
 125 * Write a commit-graph file, extending the current commit-graph file
 126   using commits in `<pack-index>`.
 127 +
 128 ------------------------------------------------
 129 $ echo <pack-index> | git commit-graph write --stdin-packs
 130 ------------------------------------------------
 131
 132 * Write a commit-graph file containing all reachable commits.
 133 +
 134 ------------------------------------------------
 135 $ git show-ref -s | git commit-graph write --stdin-commits
 136 ------------------------------------------------
 137
 138 * Write a commit-graph file containing all commits in the current
 139   commit-graph file along with those reachable from `HEAD`.
 140 +
 141 ------------------------------------------------
 142 $ git rev-parse HEAD | git commit-graph write --stdin-commits --append
 143 ------------------------------------------------
 144
 145
 146 GIT
 147 ---
 148 Part of the linkgit:git[1] suite