Skip to content

Commit c7e8ce6

Browse files
avargitster
authored andcommitted
gc doc: mention the commit-graph in the intro
Explicitly mention in the intro that we may be writing supplemental data structures such as the commit-graph during "gc", i.e. to call out the "optimize" part of what this command does, it doesn't just "collect garbage" as the "gc" name might imply. Past changes have updated the intro to reflect new commands, such as mentioning "worktree" in b586a96 ("gc.txt: more details about what gc does", 2018-03-15). So let's elaborate on what was added in d5d5d7b ("gc: automatically write commit-graph files", 2018-06-27). See also https://public-inbox.org/git/[email protected]/ (follow-up replies) for an on-list discussion about what "gc" does. Signed-off-by: Ævar Arnfjörð Bjarmason <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 5a0cc8a commit c7e8ce6

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

Documentation/git-gc.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ Runs a number of housekeeping tasks within the current repository,
1717
such as compressing file revisions (to reduce disk space and increase
1818
performance), removing unreachable objects which may have been
1919
created from prior invocations of 'git add', packing refs, pruning
20-
reflog, rerere metadata or stale working trees.
20+
reflog, rerere metadata or stale working trees. May also update ancillary
21+
indexes such as the commit-graph.
2122

2223
Users are encouraged to run this task on a regular basis within
2324
each repository to maintain good disk space utilization and good

0 commit comments

Comments
 (0)