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 read' [--object-dir <dir>]
  13 'git commit-graph verify' [--object-dir <dir>]
  14 'git commit-graph write' <options> [--object-dir <dir>]
  15
  16
  17 DESCRIPTION
  18 -----------
  19
  20 Manage the serialized commit-graph file.
  21
  22
  23 OPTIONS
  24 -------
  25 --object-dir::
  26         Use given directory for the location of packfiles and commit-graph
  27         file. This parameter exists to specify the location of an alternate
  28         that only has the objects directory, not a full `.git` directory. The
  29         commit-graph file is expected to be at `<dir>/info/commit-graph` and
  30         the packfiles are expected to be in `<dir>/pack`.
  31
  32
  33 COMMANDS
  34 --------
  35 'write'::
  36
  37 Write a commit-graph file based on the commits found in packfiles.
  38 +
  39 With the `--stdin-packs` option, generate the new commit graph by
  40 walking objects only in the specified pack-indexes. (Cannot be combined
  41 with `--stdin-commits` or `--reachable`.)
  42 +
  43 With the `--stdin-commits` option, generate the new commit graph by
  44 walking commits starting at the commits specified in stdin as a list
  45 of OIDs in hex, one OID per line. (Cannot be combined with
  46 `--stdin-packs` or `--reachable`.)
  47 +
  48 With the `--reachable` option, generate the new commit graph by walking
  49 commits starting at all refs. (Cannot be combined with `--stdin-commits`
  50 or `--stdin-packs`.)
  51 +
  52 With the `--append` option, include all commits that are present in the
  53 existing commit-graph file.
  54
  55 'read'::
  56
  57 Read the commit-graph file and output basic details about it.
  58 Used for debugging purposes.
  59
  60 'verify'::
  61
  62 Read the commit-graph file and verify its contents against the object
  63 database. Used to check for corrupted data.
  64
  65
  66 EXAMPLES
  67 --------
  68
  69 * Write a commit-graph file for the packed commits in your local `.git`
  70   directory.
  71 +
  72 ------------------------------------------------
  73 $ git commit-graph write
  74 ------------------------------------------------
  75
  76 * Write a commit-graph file, extending the current commit-graph file
  77   using commits in `<pack-index>`.
  78 +
  79 ------------------------------------------------
  80 $ echo <pack-index> | git commit-graph write --stdin-packs
  81 ------------------------------------------------
  82
  83 * Write a commit-graph file containing all reachable commits.
  84 +
  85 ------------------------------------------------
  86 $ git show-ref -s | git commit-graph write --stdin-commits
  87 ------------------------------------------------
  88
  89 * Write a commit-graph file containing all commits in the current
  90   commit-graph file along with those reachable from `HEAD`.
  91 +
  92 ------------------------------------------------
  93 $ git rev-parse HEAD | git commit-graph write --stdin-commits --append
  94 ------------------------------------------------
  95
  96 * Read basic information from the commit-graph file.
  97 +
  98 ------------------------------------------------
  99 $ git commit-graph read
 100 ------------------------------------------------
 101
 102
 103 GIT
 104 ---
 105 Part of the linkgit:git[1] suite