Derrick Stolee | 4ce58ee | 2018-04-02 16:34:18 -0400 | [diff] [blame] | 1 | git-commit-graph(1) |
| 2 | =================== |
| 3 | |
| 4 | NAME |
| 5 | ---- |
Martin Ågren | 4c39944 | 2018-09-27 21:12:22 +0200 | [diff] [blame] | 6 | git-commit-graph - Write and verify Git commit-graph files |
Derrick Stolee | 4ce58ee | 2018-04-02 16:34:18 -0400 | [diff] [blame] | 7 | |
Derrick Stolee | f237c8b | 2018-04-02 16:34:20 -0400 | [diff] [blame] | 8 | |
| 9 | SYNOPSIS |
| 10 | -------- |
| 11 | [verse] |
Garima Singh | 7371612 | 2019-08-26 09:29:58 -0700 | [diff] [blame] | 12 | 'git commit-graph verify' [--object-dir <dir>] [--shallow] [--[no-]progress] |
Ævar Arnfjörð Bjarmason | d9054a1 | 2022-10-13 17:39:18 +0200 | [diff] [blame] | 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] |
Jean-Noël Avila | 2162f9f | 2023-12-25 21:21:26 +0000 | [diff] [blame] | 16 | <split-options> |
Derrick Stolee | f237c8b | 2018-04-02 16:34:20 -0400 | [diff] [blame] | 17 | |
| 18 | |
| 19 | DESCRIPTION |
| 20 | ----------- |
| 21 | |
Martin Ågren | 4c39944 | 2018-09-27 21:12:22 +0200 | [diff] [blame] | 22 | Manage the serialized commit-graph file. |
Derrick Stolee | f237c8b | 2018-04-02 16:34:20 -0400 | [diff] [blame] | 23 | |
| 24 | |
| 25 | OPTIONS |
| 26 | ------- |
| 27 | --object-dir:: |
Martin Ågren | 4c39944 | 2018-09-27 21:12:22 +0200 | [diff] [blame] | 28 | Use given directory for the location of packfiles and commit-graph |
Derrick Stolee | f237c8b | 2018-04-02 16:34:20 -0400 | [diff] [blame] | 29 | file. This parameter exists to specify the location of an alternate |
Martin Ågren | d59a916 | 2018-09-27 21:12:20 +0200 | [diff] [blame] | 30 | that only has the objects directory, not a full `.git` directory. The |
Derrick Stolee | c2bc6e6 | 2019-06-18 11:14:32 -0700 | [diff] [blame] | 31 | commit-graph file is expected to be in the `<dir>/info` directory and |
Taylor Blau | 0bd52e2 | 2020-02-03 21:51:50 -0800 | [diff] [blame] | 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. |
Derrick Stolee | f237c8b | 2018-04-02 16:34:20 -0400 | [diff] [blame] | 36 | |
Garima Singh | 7371612 | 2019-08-26 09:29:58 -0700 | [diff] [blame] | 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. |
Derrick Stolee | f237c8b | 2018-04-02 16:34:20 -0400 | [diff] [blame] | 40 | |
| 41 | COMMANDS |
| 42 | -------- |
| 43 | 'write':: |
| 44 | |
Derrick Stolee | 85102ac | 2020-10-09 20:53:52 +0000 | [diff] [blame] | 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. |
Derrick Stolee | 049d51a | 2018-04-10 08:56:06 -0400 | [diff] [blame] | 48 | + |
| 49 | With the `--stdin-packs` option, generate the new commit graph by |
Derrick Stolee | 3d5df01 | 2018-04-10 08:56:07 -0400 | [diff] [blame] | 50 | walking objects only in the specified pack-indexes. (Cannot be combined |
Derrick Stolee | 59fb877 | 2018-06-27 09:24:45 -0400 | [diff] [blame] | 51 | with `--stdin-commits` or `--reachable`.) |
Derrick Stolee | 3d5df01 | 2018-04-10 08:56:07 -0400 | [diff] [blame] | 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 |
Taylor Blau | 2f00c35 | 2020-05-13 15:59:55 -0600 | [diff] [blame] | 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`.) |
Derrick Stolee | 59fb877 | 2018-06-27 09:24:45 -0400 | [diff] [blame] | 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`.) |
Derrick Stolee | 7547b95 | 2018-04-10 08:56:08 -0400 | [diff] [blame] | 63 | + |
| 64 | With the `--append` option, include all commits that are present in the |
| 65 | existing commit-graph file. |
Derrick Stolee | c2bc6e6 | 2019-06-18 11:14:32 -0700 | [diff] [blame] | 66 | + |
Garima Singh | d38e07b | 2020-04-06 16:59:51 +0000 | [diff] [blame] | 67 | With the `--changed-paths` option, compute and write information about the |
Martin Ågren | 1aa7b68 | 2020-05-17 20:52:18 +0200 | [diff] [blame] | 68 | paths changed between a commit and its first parent. This operation can |
Garima Singh | d38e07b | 2020-04-06 16:59:51 +0000 | [diff] [blame] | 69 | take a while on large repositories. It provides significant performance gains |
Derrick Stolee | 0087a87 | 2020-07-01 13:27:24 +0000 | [diff] [blame] | 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. |
Garima Singh | d38e07b | 2020-04-06 16:59:51 +0000 | [diff] [blame] | 74 | + |
Taylor Blau | 809e032 | 2020-09-18 09:27:27 -0400 | [diff] [blame] | 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 |
Taylor Blau | d356d5d | 2020-09-17 22:59:57 -0400 | [diff] [blame] | 79 | advised to use `--split=replace`. Overrides the `commitGraph.maxNewFilters` |
| 80 | configuration. |
Taylor Blau | 809e032 | 2020-09-18 09:27:27 -0400 | [diff] [blame] | 81 | + |
Taylor Blau | 4f02735 | 2020-04-13 22:04:08 -0600 | [diff] [blame] | 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: |
Martin Ågren | ce3614c | 2020-05-17 20:52:19 +0200 | [diff] [blame] | 88 | + |
Taylor Blau | fdbde82 | 2020-04-13 22:04:12 -0600 | [diff] [blame] | 89 | * If `--split=no-merge` is specified, a merge is never performed, and |
Taylor Blau | 8a6ac28 | 2020-04-13 22:04:17 -0600 | [diff] [blame] | 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 |
Taylor Blau | fdbde82 | 2020-04-13 22:04:12 -0600 | [diff] [blame] | 94 | incremental holds the entire graph). |
Derrick Stolee | c2bc6e6 | 2019-06-18 11:14:32 -0700 | [diff] [blame] | 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`. |
Derrick Stolee | f237c8b | 2018-04-02 16:34:20 -0400 | [diff] [blame] | 108 | |
Derrick Stolee | 283e68c | 2018-06-27 09:24:32 -0400 | [diff] [blame] | 109 | 'verify':: |
| 110 | |
| 111 | Read the commit-graph file and verify its contents against the object |
| 112 | database. Used to check for corrupted data. |
Derrick Stolee | 3da4b60 | 2019-06-18 11:14:32 -0700 | [diff] [blame] | 113 | + |
| 114 | With the `--shallow` option, only check the tip commit-graph file in |
| 115 | a chain of split commit-graphs. |
Derrick Stolee | 283e68c | 2018-06-27 09:24:32 -0400 | [diff] [blame] | 116 | |
Derrick Stolee | f237c8b | 2018-04-02 16:34:20 -0400 | [diff] [blame] | 117 | |
| 118 | EXAMPLES |
| 119 | -------- |
| 120 | |
Martin Ågren | 4c39944 | 2018-09-27 21:12:22 +0200 | [diff] [blame] | 121 | * Write a commit-graph file for the packed commits in your local `.git` |
Martin Ågren | d59a916 | 2018-09-27 21:12:20 +0200 | [diff] [blame] | 122 | directory. |
Derrick Stolee | f237c8b | 2018-04-02 16:34:20 -0400 | [diff] [blame] | 123 | + |
| 124 | ------------------------------------------------ |
| 125 | $ git commit-graph write |
| 126 | ------------------------------------------------ |
| 127 | |
Martin Ågren | 4893d71 | 2018-09-27 21:12:21 +0200 | [diff] [blame] | 128 | * Write a commit-graph file, extending the current commit-graph file |
| 129 | using commits in `<pack-index>`. |
Derrick Stolee | 049d51a | 2018-04-10 08:56:06 -0400 | [diff] [blame] | 130 | + |
| 131 | ------------------------------------------------ |
| 132 | $ echo <pack-index> | git commit-graph write --stdin-packs |
| 133 | ------------------------------------------------ |
| 134 | |
Martin Ågren | 4893d71 | 2018-09-27 21:12:21 +0200 | [diff] [blame] | 135 | * Write a commit-graph file containing all reachable commits. |
Derrick Stolee | 3d5df01 | 2018-04-10 08:56:07 -0400 | [diff] [blame] | 136 | + |
| 137 | ------------------------------------------------ |
| 138 | $ git show-ref -s | git commit-graph write --stdin-commits |
| 139 | ------------------------------------------------ |
| 140 | |
Martin Ågren | 4893d71 | 2018-09-27 21:12:21 +0200 | [diff] [blame] | 141 | * Write a commit-graph file containing all commits in the current |
Martin Ågren | d59a916 | 2018-09-27 21:12:20 +0200 | [diff] [blame] | 142 | commit-graph file along with those reachable from `HEAD`. |
Derrick Stolee | 7547b95 | 2018-04-10 08:56:08 -0400 | [diff] [blame] | 143 | + |
| 144 | ------------------------------------------------ |
| 145 | $ git rev-parse HEAD | git commit-graph write --stdin-commits --append |
| 146 | ------------------------------------------------ |
| 147 | |
Ævar Arnfjörð Bjarmason | 16f6b0d | 2022-09-07 10:27:04 +0200 | [diff] [blame] | 148 | CONFIGURATION |
| 149 | ------------- |
| 150 | |
| 151 | include::includes/cmd-config-section-all.txt[] |
| 152 | |
| 153 | include::config/commitgraph.txt[] |
| 154 | |
Derrick Stolee | f237c8b | 2018-04-02 16:34:20 -0400 | [diff] [blame] | 155 | |
Ævar Arnfjörð Bjarmason | 8cbace9 | 2022-08-04 18:28:35 +0200 | [diff] [blame] | 156 | FILE FORMAT |
| 157 | ----------- |
| 158 | |
| 159 | see linkgit:gitformat-commit-graph[5]. |
| 160 | |
Derrick Stolee | 4ce58ee | 2018-04-02 16:34:18 -0400 | [diff] [blame] | 161 | GIT |
| 162 | --- |
| 163 | Part of the linkgit:git[1] suite |