{"thread":{"id":"49530","subject":"[PATCH] gc doc: mention the commit-graph in the intro","startedAt":"2018-10-10T19:38:30Z","lastAt":"2018-10-10T19:38:30Z","messageCount":1,"participants":["Ævar Arnfjörð Bjarmason"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"360063","messageId":"20181010193818.20399-1-avarab@gmail.com","threadId":"49530","inReplyTo":null,"subject":"[PATCH] gc doc: mention the commit-graph in the intro","fromName":"Ævar Arnfjörð Bjarmason","fromEmail":"avarab@gmail.com","sentAt":"2018-10-10T19:38:18Z","receivedAt":"2018-10-10T19:38:30Z","isPatch":true,"sender":{"key":"avarab@gmail.com","avatar":"https://avatars.githubusercontent.com/u/45301?v=4"},"body":"Explicitly mention in the intro that we may be writing supplemental\ndata structures such as the commit-graph during \"gc\", i.e. to call out\nthe \"optimize\" part of what this command does, it doesn't just\n\"collect garbage\" as the \"gc\" name might imply.\n\nPast changes have updated the intro to reflect new commands, such as\nmentioning \"worktree\" in b586a96a39 (\"gc.txt: more details about what\ngc does\", 2018-03-15). So let's elaborate on what was added in\nd5d5d7b641 (\"gc: automatically write commit-graph files\", 2018-06-27).\n\nSee also\nhttps://public-inbox.org/git/87tvm3go42.fsf@evledraar.gmail.com/ (follow-up\nreplies) for an on-list discussion about what \"gc\" does.\n\nSigned-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>\n---\n\nIn light of the linked thread let's see how controversial this is as a\nstand-alone :)\n\n Documentation/git-gc.txt | 3 ++-\n 1 file changed, 2 insertions(+), 1 deletion(-)\n\ndiff --git a/Documentation/git-gc.txt b/Documentation/git-gc.txt\nindex f5bc98ccb3..c20ee6c789 100644\n--- a/Documentation/git-gc.txt\n+++ b/Documentation/git-gc.txt\n@@ -17,7 +17,8 @@ Runs a number of housekeeping tasks within the current repository,\n such as compressing file revisions (to reduce disk space and increase\n performance), removing unreachable objects which may have been\n created from prior invocations of 'git add', packing refs, pruning\n-reflog, rerere metadata or stale working trees.\n+reflog, rerere metadata or stale working trees. May also update ancillary\n+indexes such as the commit-graph.\n \n Users are encouraged to run this task on a regular basis within\n each repository to maintain good disk space utilization and good\n-- \n2.19.1.390.gf3a00b506f\n\n"}]}