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`.
  30
  31 --[no-]progress::
  32         Turn progress on/off explicitly. If neither is specified, progress is
  33         shown if standard error is connected to a terminal.
  34
  35 COMMANDS
  36 --------
  37 'write'::
  38
  39 Write a commit-graph file based on the commits found in packfiles.
  40 +
  41 With the `--stdin-packs` option, generate the new commit graph by
  42 walking objects only in the specified pack-indexes. (Cannot be combined
  43 with `--stdin-commits` or `--reachable`.)
  44 +
  45 With the `--stdin-commits` option, generate the new commit graph by
  46 walking commits starting at the commits specified in stdin as a list
  47 of OIDs in hex, one OID per line. (Cannot be combined with
  48 `--stdin-packs` or `--reachable`.)
  49 +
  50 With the `--reachable` option, generate the new commit graph by walking
  51 commits starting at all refs. (Cannot be combined with `--stdin-commits`
  52 or `--stdin-packs`.)
  53 +
  54 With the `--append` option, include all commits that are present in the
  55 existing commit-graph file.
  56 +
  57 With the `--split` option, write the commit-graph as a chain of multiple
  58 commit-graph files stored in `<dir>/info/commit-graphs`. The new commits
  59 not already in the commit-graph are added in a new "tip" file. This file
  60 is merged with the existing file if the following merge conditions are
  61 met:
  62 +
  63 * If `--size-multiple=<X>` is not specified, let `X` equal 2. If the new
  64 tip file would have `N` commits and the previous tip has `M` commits and
  65 `X` times `N` is greater than  `M`, instead merge the two files into a
  66 single file.
  67 +
  68 * If `--max-commits=<M>` is specified with `M` a positive integer, and the
  69 new tip file would have more than `M` commits, then instead merge the new
  70 tip with the previous tip.
  71 +
  72 Finally, if `--expire-time=<datetime>` is not specified, let `datetime`
  73 be the current time. After writing the split commit-graph, delete all
  74 unused commit-graph whose modified times are older than `datetime`.
  75
  76 'verify'::
  77
  78 Read the commit-graph file and verify its contents against the object
  79 database. Used to check for corrupted data.
  80 +
  81 With the `--shallow` option, only check the tip commit-graph file in
  82 a chain of split commit-graphs.
  83
  84
  85 EXAMPLES
  86 --------
  87
  88 * Write a commit-graph file for the packed commits in your local `.git`
  89   directory.
  90 +
  91 ------------------------------------------------
  92 $ git commit-graph write
  93 ------------------------------------------------
  94
  95 * Write a commit-graph file, extending the current commit-graph file
  96   using commits in `<pack-index>`.
  97 +
  98 ------------------------------------------------
  99 $ echo <pack-index> | git commit-graph write --stdin-packs
 100 ------------------------------------------------
 101
 102 * Write a commit-graph file containing all reachable commits.
 103 +
 104 ------------------------------------------------
 105 $ git show-ref -s | git commit-graph write --stdin-commits
 106 ------------------------------------------------
 107
 108 * Write a commit-graph file containing all commits in the current
 109   commit-graph file along with those reachable from `HEAD`.
 110 +
 111 ------------------------------------------------
 112 $ git rev-parse HEAD | git commit-graph write --stdin-commits --append
 113 ------------------------------------------------
 114
 115
 116 GIT
 117 ---
 118 Part of the linkgit:git[1] suite