gc doc: mention the commit-graph in the intro
commitc7e8ce6d1dd02f6569ea785eebc8692e8e2edf72
authorÆvar Arnfjörð Bjarmason <avarab@gmail.com>
Wed, 10 Oct 2018 19:38:18 +0000 (10 19:38 +0000)
committerJunio C Hamano <gitster@pobox.com>
Thu, 11 Oct 2018 06:40:27 +0000 (11 15:40 +0900)
tree17e91fedbc545c3103a95b178c3e5101e8b101dd
parent5a0cc8aca797dbd7d2be3b67458ff880ed45cddf
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 b586a96a39 ("gc.txt: more details about what
gc does", 2018-03-15). So let's elaborate on what was added in
d5d5d7b641 ("gc: automatically write commit-graph files", 2018-06-27).

See also
https://public-inbox.org/git/87tvm3go42.fsf@evledraar.gmail.com/ (follow-up
replies) for an on-list discussion about what "gc" does.

Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-gc.txt