]>
Commit | Line | Data |
---|---|---|
4ce58ee3 DS |
1 | git-commit-graph(1) |
2 | =================== | |
3 | ||
4 | NAME | |
5 | ---- | |
4c399442 | 6 | git-commit-graph - Write and verify Git commit-graph files |
4ce58ee3 | 7 | |
f237c8b6 DS |
8 | |
9 | SYNOPSIS | |
10 | -------- | |
11 | [verse] | |
73716122 GS |
12 | 'git commit-graph verify' [--object-dir <dir>] [--shallow] [--[no-]progress] |
13 | 'git commit-graph write' <options> [--object-dir <dir>] [--[no-]progress] | |
f237c8b6 DS |
14 | |
15 | ||
16 | DESCRIPTION | |
17 | ----------- | |
18 | ||
4c399442 | 19 | Manage the serialized commit-graph file. |
f237c8b6 DS |
20 | |
21 | ||
22 | OPTIONS | |
23 | ------- | |
24 | --object-dir:: | |
4c399442 | 25 | Use given directory for the location of packfiles and commit-graph |
f237c8b6 | 26 | file. This parameter exists to specify the location of an alternate |
d59a9168 | 27 | that only has the objects directory, not a full `.git` directory. The |
c2bc6e6a | 28 | commit-graph file is expected to be in the `<dir>/info` directory and |
0bd52e27 TB |
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. | |
f237c8b6 | 33 | |
73716122 GS |
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. | |
f237c8b6 DS |
37 | |
38 | COMMANDS | |
39 | -------- | |
40 | 'write':: | |
41 | ||
85102ac7 DS |
42 | Write a commit-graph file based on the commits found in packfiles. If |
43 | the config option `core.commitGraph` is disabled, then this command will | |
44 | output a warning, then return success without writing a commit-graph file. | |
049d51a2 DS |
45 | + |
46 | With the `--stdin-packs` option, generate the new commit graph by | |
3d5df01b | 47 | walking objects only in the specified pack-indexes. (Cannot be combined |
59fb8770 | 48 | with `--stdin-commits` or `--reachable`.) |
3d5df01b DS |
49 | + |
50 | With the `--stdin-commits` option, generate the new commit graph by | |
51 | walking commits starting at the commits specified in stdin as a list | |
2f00c355 TB |
52 | of OIDs in hex, one OID per line. OIDs that resolve to non-commits |
53 | (either directly, or by peeling tags) are silently ignored. OIDs that | |
54 | are malformed, or do not exist generate an error. (Cannot be combined | |
55 | with `--stdin-packs` or `--reachable`.) | |
59fb8770 DS |
56 | + |
57 | With the `--reachable` option, generate the new commit graph by walking | |
58 | commits starting at all refs. (Cannot be combined with `--stdin-commits` | |
59 | or `--stdin-packs`.) | |
7547b95b DS |
60 | + |
61 | With the `--append` option, include all commits that are present in the | |
62 | existing commit-graph file. | |
c2bc6e6a | 63 | + |
d38e07b8 | 64 | With the `--changed-paths` option, compute and write information about the |
1aa7b686 | 65 | paths changed between a commit and its first parent. This operation can |
d38e07b8 | 66 | take a while on large repositories. It provides significant performance gains |
0087a87b DS |
67 | for getting history of a directory or a file with `git log -- <path>`. If |
68 | this option is given, future commit-graph writes will automatically assume | |
69 | that this option was intended. Use `--no-changed-paths` to stop storing this | |
70 | data. | |
d38e07b8 | 71 | + |
809e0327 TB |
72 | With the `--max-new-filters=<n>` option, generate at most `n` new Bloom |
73 | filters (if `--changed-paths` is specified). If `n` is `-1`, no limit is | |
74 | enforced. Only commits present in the new layer count against this | |
75 | limit. To retroactively compute Bloom filters over earlier layers, it is | |
d356d5de TB |
76 | advised to use `--split=replace`. Overrides the `commitGraph.maxNewFilters` |
77 | configuration. | |
809e0327 | 78 | + |
4f027355 TB |
79 | With the `--split[=<strategy>]` option, write the commit-graph as a |
80 | chain of multiple commit-graph files stored in | |
81 | `<dir>/info/commit-graphs`. Commit-graph layers are merged based on the | |
82 | strategy and other splitting options. The new commits not already in the | |
83 | commit-graph are added in a new "tip" file. This file is merged with the | |
84 | existing file if the following merge conditions are met: | |
ce3614c3 | 85 | + |
fdbde82f | 86 | * If `--split=no-merge` is specified, a merge is never performed, and |
8a6ac287 TB |
87 | the remaining options are ignored. `--split=replace` overwrites the |
88 | existing chain with a new one. A bare `--split` defers to the remaining | |
89 | options. (Note that merging a chain of commit graphs replaces the | |
90 | existing chain with a length-1 chain where the first and only | |
fdbde82f | 91 | incremental holds the entire graph). |
c2bc6e6a DS |
92 | + |
93 | * If `--size-multiple=<X>` is not specified, let `X` equal 2. If the new | |
94 | tip file would have `N` commits and the previous tip has `M` commits and | |
95 | `X` times `N` is greater than `M`, instead merge the two files into a | |
96 | single file. | |
97 | + | |
98 | * If `--max-commits=<M>` is specified with `M` a positive integer, and the | |
99 | new tip file would have more than `M` commits, then instead merge the new | |
100 | tip with the previous tip. | |
101 | + | |
102 | Finally, if `--expire-time=<datetime>` is not specified, let `datetime` | |
103 | be the current time. After writing the split commit-graph, delete all | |
104 | unused commit-graph whose modified times are older than `datetime`. | |
f237c8b6 | 105 | |
283e68c7 DS |
106 | 'verify':: |
107 | ||
108 | Read the commit-graph file and verify its contents against the object | |
109 | database. Used to check for corrupted data. | |
3da4b609 DS |
110 | + |
111 | With the `--shallow` option, only check the tip commit-graph file in | |
112 | a chain of split commit-graphs. | |
283e68c7 | 113 | |
f237c8b6 DS |
114 | |
115 | EXAMPLES | |
116 | -------- | |
117 | ||
4c399442 | 118 | * Write a commit-graph file for the packed commits in your local `.git` |
d59a9168 | 119 | directory. |
f237c8b6 DS |
120 | + |
121 | ------------------------------------------------ | |
122 | $ git commit-graph write | |
123 | ------------------------------------------------ | |
124 | ||
4893d717 MÅ |
125 | * Write a commit-graph file, extending the current commit-graph file |
126 | using commits in `<pack-index>`. | |
049d51a2 DS |
127 | + |
128 | ------------------------------------------------ | |
129 | $ echo <pack-index> | git commit-graph write --stdin-packs | |
130 | ------------------------------------------------ | |
131 | ||
4893d717 | 132 | * Write a commit-graph file containing all reachable commits. |
3d5df01b DS |
133 | + |
134 | ------------------------------------------------ | |
135 | $ git show-ref -s | git commit-graph write --stdin-commits | |
136 | ------------------------------------------------ | |
137 | ||
4893d717 | 138 | * Write a commit-graph file containing all commits in the current |
d59a9168 | 139 | commit-graph file along with those reachable from `HEAD`. |
7547b95b DS |
140 | + |
141 | ------------------------------------------------ | |
142 | $ git rev-parse HEAD | git commit-graph write --stdin-commits --append | |
143 | ------------------------------------------------ | |
144 | ||
f237c8b6 | 145 | |
4ce58ee3 DS |
146 | GIT |
147 | --- | |
148 | Part of the linkgit:git[1] suite |