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