]>
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] | |
2a2e32bd | 12 | 'git commit-graph read' [--object-dir <dir>] |
73716122 GS |
13 | 'git commit-graph verify' [--object-dir <dir>] [--shallow] [--[no-]progress] |
14 | 'git commit-graph write' <options> [--object-dir <dir>] [--[no-]progress] | |
f237c8b6 DS |
15 | |
16 | ||
17 | DESCRIPTION | |
18 | ----------- | |
19 | ||
4c399442 | 20 | Manage the serialized commit-graph file. |
f237c8b6 DS |
21 | |
22 | ||
23 | OPTIONS | |
24 | ------- | |
25 | --object-dir:: | |
4c399442 | 26 | Use given directory for the location of packfiles and commit-graph |
f237c8b6 | 27 | file. This parameter exists to specify the location of an alternate |
d59a9168 | 28 | that only has the objects directory, not a full `.git` directory. The |
c2bc6e6a | 29 | commit-graph file is expected to be in the `<dir>/info` directory and |
d59a9168 | 30 | the packfiles are expected to be in `<dir>/pack`. |
f237c8b6 | 31 | |
73716122 GS |
32 | --[no-]progress:: |
33 | Turn progress on/off explicitly. If neither is specified, progress is | |
34 | shown if standard error is connected to a terminal. | |
f237c8b6 DS |
35 | |
36 | COMMANDS | |
37 | -------- | |
38 | 'write':: | |
39 | ||
4c399442 | 40 | Write a commit-graph file based on the commits found in packfiles. |
049d51a2 DS |
41 | + |
42 | With the `--stdin-packs` option, generate the new commit graph by | |
3d5df01b | 43 | walking objects only in the specified pack-indexes. (Cannot be combined |
59fb8770 | 44 | with `--stdin-commits` or `--reachable`.) |
3d5df01b DS |
45 | + |
46 | With the `--stdin-commits` option, generate the new commit graph by | |
47 | walking commits starting at the commits specified in stdin as a list | |
48 | of OIDs in hex, one OID per line. (Cannot be combined with | |
59fb8770 DS |
49 | `--stdin-packs` or `--reachable`.) |
50 | + | |
51 | With the `--reachable` option, generate the new commit graph by walking | |
52 | commits starting at all refs. (Cannot be combined with `--stdin-commits` | |
53 | or `--stdin-packs`.) | |
7547b95b DS |
54 | + |
55 | With the `--append` option, include all commits that are present in the | |
56 | existing commit-graph file. | |
c2bc6e6a DS |
57 | + |
58 | With the `--split` option, write the commit-graph as a chain of multiple | |
59 | commit-graph files stored in `<dir>/info/commit-graphs`. The new commits | |
60 | not already in the commit-graph are added in a new "tip" file. This file | |
61 | is merged with the existing file if the following merge conditions are | |
62 | met: | |
63 | + | |
64 | * If `--size-multiple=<X>` is not specified, let `X` equal 2. If the new | |
65 | tip file would have `N` commits and the previous tip has `M` commits and | |
66 | `X` times `N` is greater than `M`, instead merge the two files into a | |
67 | single file. | |
68 | + | |
69 | * If `--max-commits=<M>` is specified with `M` a positive integer, and the | |
70 | new tip file would have more than `M` commits, then instead merge the new | |
71 | tip with the previous tip. | |
72 | + | |
73 | Finally, if `--expire-time=<datetime>` is not specified, let `datetime` | |
74 | be the current time. After writing the split commit-graph, delete all | |
75 | unused commit-graph whose modified times are older than `datetime`. | |
f237c8b6 | 76 | |
2a2e32bd DS |
77 | 'read':: |
78 | ||
4893d717 MÅ |
79 | Read the commit-graph file and output basic details about it. |
80 | Used for debugging purposes. | |
2a2e32bd | 81 | |
283e68c7 DS |
82 | 'verify':: |
83 | ||
84 | Read the commit-graph file and verify its contents against the object | |
85 | database. Used to check for corrupted data. | |
3da4b609 DS |
86 | + |
87 | With the `--shallow` option, only check the tip commit-graph file in | |
88 | a chain of split commit-graphs. | |
283e68c7 | 89 | |
f237c8b6 DS |
90 | |
91 | EXAMPLES | |
92 | -------- | |
93 | ||
4c399442 | 94 | * Write a commit-graph file for the packed commits in your local `.git` |
d59a9168 | 95 | directory. |
f237c8b6 DS |
96 | + |
97 | ------------------------------------------------ | |
98 | $ git commit-graph write | |
99 | ------------------------------------------------ | |
100 | ||
4893d717 MÅ |
101 | * Write a commit-graph file, extending the current commit-graph file |
102 | using commits in `<pack-index>`. | |
049d51a2 DS |
103 | + |
104 | ------------------------------------------------ | |
105 | $ echo <pack-index> | git commit-graph write --stdin-packs | |
106 | ------------------------------------------------ | |
107 | ||
4893d717 | 108 | * Write a commit-graph file containing all reachable commits. |
3d5df01b DS |
109 | + |
110 | ------------------------------------------------ | |
111 | $ git show-ref -s | git commit-graph write --stdin-commits | |
112 | ------------------------------------------------ | |
113 | ||
4893d717 | 114 | * Write a commit-graph file containing all commits in the current |
d59a9168 | 115 | commit-graph file along with those reachable from `HEAD`. |
7547b95b DS |
116 | + |
117 | ------------------------------------------------ | |
118 | $ git rev-parse HEAD | git commit-graph write --stdin-commits --append | |
119 | ------------------------------------------------ | |
120 | ||
2a2e32bd DS |
121 | * Read basic information from the commit-graph file. |
122 | + | |
123 | ------------------------------------------------ | |
124 | $ git commit-graph read | |
125 | ------------------------------------------------ | |
126 | ||
f237c8b6 | 127 | |
4ce58ee3 DS |
128 | GIT |
129 | --- | |
130 | Part of the linkgit:git[1] suite |