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