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.
  43 +
  44 With the `--stdin-packs` option, generate the new commit graph by
  45 walking objects only in the specified pack-indexes. (Cannot be combined
  46 with `--stdin-commits` or `--reachable`.)
  47 +
  48 With the `--stdin-commits` option, generate the new commit graph by
  49 walking commits starting at the commits specified in stdin as a list
  50 of OIDs in hex, one OID per line. OIDs that resolve to non-commits
  51 (either directly, or by peeling tags) are silently ignored. OIDs that
  52 are malformed, or do not exist generate an error. (Cannot be combined
  53 with `--stdin-packs` or `--reachable`.)
  54 +
  55 With the `--reachable` option, generate the new commit graph by walking
  56 commits starting at all refs. (Cannot be combined with `--stdin-commits`
  57 or `--stdin-packs`.)
  58 +
  59 With the `--append` option, include all commits that are present in the
  60 existing commit-graph file.
  61 +
  62 With the `--changed-paths` option, compute and write information about the
  63 paths changed between a commit and its first parent. This operation can
  64 take a while on large repositories. It provides significant performance gains
  65 for getting history of a directory or a file with `git log -- <path>`. If
  66 this option is given, future commit-graph writes will automatically assume
  67 that this option was intended. Use `--no-changed-paths` to stop storing this
  68 data.
  69 +
  70 With the `--split[=<strategy>]` option, write the commit-graph as a
  71 chain of multiple commit-graph files stored in
  72 `<dir>/info/commit-graphs`. Commit-graph layers are merged based on the
  73 strategy and other splitting options. The new commits not already in the
  74 commit-graph are added in a new "tip" file. This file is merged with the
  75 existing file if the following merge conditions are met:
  76 +
  77 * If `--split=no-merge` is specified, a merge is never performed, and
  78 the remaining options are ignored. `--split=replace` overwrites the
  79 existing chain with a new one. A bare `--split` defers to the remaining
  80 options. (Note that merging a chain of commit graphs replaces the
  81 existing chain with a length-1 chain where the first and only
  82 incremental holds the entire graph).
  83 +
  84 * If `--size-multiple=<X>` is not specified, let `X` equal 2. If the new
  85 tip file would have `N` commits and the previous tip has `M` commits and
  86 `X` times `N` is greater than  `M`, instead merge the two files into a
  87 single file.
  88 +
  89 * If `--max-commits=<M>` is specified with `M` a positive integer, and the
  90 new tip file would have more than `M` commits, then instead merge the new
  91 tip with the previous tip.
  92 +
  93 Finally, if `--expire-time=<datetime>` is not specified, let `datetime`
  94 be the current time. After writing the split commit-graph, delete all
  95 unused commit-graph whose modified times are older than `datetime`.
  96
  97 'verify'::
  98
  99 Read the commit-graph file and verify its contents against the object
 100 database. Used to check for corrupted data.
 101 +
 102 With the `--shallow` option, only check the tip commit-graph file in
 103 a chain of split commit-graphs.
 104
 105
 106 EXAMPLES
 107 --------
 108
 109 * Write a commit-graph file for the packed commits in your local `.git`
 110   directory.
 111 +
 112 ------------------------------------------------
 113 $ git commit-graph write
 114 ------------------------------------------------
 115
 116 * Write a commit-graph file, extending the current commit-graph file
 117   using commits in `<pack-index>`.
 118 +
 119 ------------------------------------------------
 120 $ echo <pack-index> | git commit-graph write --stdin-packs
 121 ------------------------------------------------
 122
 123 * Write a commit-graph file containing all reachable commits.
 124 +
 125 ------------------------------------------------
 126 $ git show-ref -s | git commit-graph write --stdin-commits
 127 ------------------------------------------------
 128
 129 * Write a commit-graph file containing all commits in the current
 130   commit-graph file along with those reachable from `HEAD`.
 131 +
 132 ------------------------------------------------
 133 $ git rev-parse HEAD | git commit-graph write --stdin-commits --append
 134 ------------------------------------------------
 135
 136
 137 GIT
 138 ---
 139 Part of the linkgit:git[1] suite