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