]>
Commit | Line | Data |
---|---|---|
4ce58ee3 DS |
1 | git-commit-graph(1) |
2 | =================== | |
3 | ||
4 | NAME | |
5 | ---- | |
6 | git-commit-graph - Write and verify Git commit graph files | |
7 | ||
f237c8b6 DS |
8 | |
9 | SYNOPSIS | |
10 | -------- | |
11 | [verse] | |
2a2e32bd | 12 | 'git commit-graph read' [--object-dir <dir>] |
283e68c7 | 13 | 'git commit-graph verify' [--object-dir <dir>] |
f237c8b6 DS |
14 | 'git commit-graph write' <options> [--object-dir <dir>] |
15 | ||
16 | ||
17 | DESCRIPTION | |
18 | ----------- | |
19 | ||
20 | Manage the serialized commit graph file. | |
21 | ||
22 | ||
23 | OPTIONS | |
24 | ------- | |
25 | --object-dir:: | |
26 | Use given directory for the location of packfiles and commit graph | |
27 | file. This parameter exists to specify the location of an alternate | |
28 | that only has the objects directory, not a full .git directory. The | |
29 | commit graph file is expected to be at <dir>/info/commit-graph and | |
30 | the packfiles are expected to be in <dir>/pack. | |
31 | ||
32 | ||
33 | COMMANDS | |
34 | -------- | |
35 | 'write':: | |
36 | ||
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. | |
f237c8b6 | 54 | |
2a2e32bd DS |
55 | 'read':: |
56 | ||
57 | Read a graph file given by the commit-graph file and output basic | |
58 | details about the graph file. Used for debugging purposes. | |
59 | ||
283e68c7 DS |
60 | 'verify':: |
61 | ||
62 | Read the commit-graph file and verify its contents against the object | |
63 | database. Used to check for corrupted data. | |
64 | ||
f237c8b6 DS |
65 | |
66 | EXAMPLES | |
67 | -------- | |
68 | ||
69 | * Write a commit graph file for the packed commits in your local .git folder. | |
70 | + | |
71 | ------------------------------------------------ | |
72 | $ git commit-graph write | |
73 | ------------------------------------------------ | |
74 | ||
049d51a2 DS |
75 | * Write a graph file, extending the current graph file using commits |
76 | * in <pack-index>. | |
77 | + | |
78 | ------------------------------------------------ | |
79 | $ echo <pack-index> | git commit-graph write --stdin-packs | |
80 | ------------------------------------------------ | |
81 | ||
3d5df01b DS |
82 | * Write a graph file containing all reachable commits. |
83 | + | |
84 | ------------------------------------------------ | |
85 | $ git show-ref -s | git commit-graph write --stdin-commits | |
86 | ------------------------------------------------ | |
87 | ||
7547b95b DS |
88 | * Write a graph file containing all commits in the current |
89 | * commit-graph file along with those reachable from HEAD. | |
90 | + | |
91 | ------------------------------------------------ | |
92 | $ git rev-parse HEAD | git commit-graph write --stdin-commits --append | |
93 | ------------------------------------------------ | |
94 | ||
2a2e32bd DS |
95 | * Read basic information from the commit-graph file. |
96 | + | |
97 | ------------------------------------------------ | |
98 | $ git commit-graph read | |
99 | ------------------------------------------------ | |
100 | ||
f237c8b6 | 101 | |
4ce58ee3 DS |
102 | GIT |
103 | --- | |
104 | Part of the linkgit:git[1] suite |