From patchwork Mon Mar 18 16:14:59 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= X-Patchwork-Id: 10857991 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 814006C2 for ; Mon, 18 Mar 2019 16:15:21 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 68C1829080 for ; Mon, 18 Mar 2019 16:15:21 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 5C51B2909C; Mon, 18 Mar 2019 16:15:21 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-8.0 required=2.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FROM,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 0740B29080 for ; Mon, 18 Mar 2019 16:15:21 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727603AbfCRQPU (ORCPT ); Mon, 18 Mar 2019 12:15:20 -0400 Received: from mail-wr1-f68.google.com ([209.85.221.68]:34030 "EHLO mail-wr1-f68.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726914AbfCRQPT (ORCPT ); Mon, 18 Mar 2019 12:15:19 -0400 Received: by mail-wr1-f68.google.com with SMTP id k1so17268129wre.1 for ; Mon, 18 Mar 2019 09:15:18 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=YSf9p0wnG9SD9rIAiaQUadLh5xdeaOQHCnci9LKfWSA=; b=o1Rpq/NDe7ICYMzoNUW0lTJd0tj7nfd8uZsN96o1H9DGj8Zt16tBpjSjcBelJVGsJY gBMVvpPmS0RzbMvj2hnHZo6XucuHVlJmvvNNmWDQto3v6dLd6NHqeyav0utPvqUGyL69 Huqa90pgds50kZdifD3qXsS578d59tnBmZjXShRtaKPOrYGO8PGkl+SqIb1z2IPnoIhe 9bK+zsCRvRxJoaVxFI1664DImCKkUsUY4//nqdRkKle+WHtviql3nTXeR4XxlFZIKUPm +LyoV0ka/Ep40KWAS5isd0WyIn8kYRsrwVSreOFuuYCeAwBqING/EKlRqtg6yBLx1s+l V60w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=YSf9p0wnG9SD9rIAiaQUadLh5xdeaOQHCnci9LKfWSA=; b=f+sOjAaXfNMNHyaU2auP8CfD6Htq3mZbgmTyW62AWClEgJdzijPIWoEwWafUKNKoQt BmQSindF8VRvOjGhWTZ8htvRlq7y8G/+zWKhWxJX1DBIrk/wWaatBusKOe0QOwn+SJTC bKzfTYNTHodNJzZ2r7mMOahr0YjQv0vUC63apiXwG+yRB2GO3+Uae3B9YSjbBReQVkVk NtSANrwgSxSbBLjYyrwbF/3FUd71c0obv59513354aeWSwlNCOGfdt02cmJ/vCkKsd3Y cXVN/sdtviDtXk6YhOcM73zkrqspKMGek+6NyaPhBIL5V1eZ2olNhzza6van7ZUO1sIh gBjQ== X-Gm-Message-State: APjAAAVCJJIDJmr1O36qjh9if48cO+NrAj1uynI9TN6ENnionAMoqN5P ERU542WLgRA3xynRAonJIC+umz3SBfo= X-Google-Smtp-Source: APXvYqyvHsFTO41PgzmqgMpP16QRyLyQHDl81isOR7UrWsDFVRKNuTp2B4wUK8JkZ6ZwXf4jVpGmkQ== X-Received: by 2002:adf:eac6:: with SMTP id o6mr12301618wrn.77.1552925717599; Mon, 18 Mar 2019 09:15:17 -0700 (PDT) Received: from vm.nix.is ([2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id z9sm3269728wmf.12.2019.03.18.09.15.15 (version=TLS1_3 cipher=AEAD-AES256-GCM-SHA384 bits=256/256); Mon, 18 Mar 2019 09:15:16 -0700 (PDT) From: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= To: git@vger.kernel.org Cc: Junio C Hamano , =?utf-8?b?Tmd1eeG7hW4gVGjDoWkgTmc=?= =?utf-8?b?4buNYyBEdXk=?= , Jeff King , Michael Haggerty , Stefan Beller , Jonathan Nieder , Matt McCutchen , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBC?= =?utf-8?b?amFybWFzb24=?= Subject: [PATCH 1/4] gc docs: modernize the advice for manually running "gc" Date: Mon, 18 Mar 2019 17:14:59 +0100 Message-Id: <20190318161502.7979-2-avarab@gmail.com> X-Mailer: git-send-email 2.21.0.360.g471c308f928 In-Reply-To: <20190318161502.7979-1-avarab@gmail.com> References: <20190318161502.7979-1-avarab@gmail.com> MIME-Version: 1.0 Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP The docs have been recommending that users need to run this manually, but that hasn't been needed in practice for a long time. Let's instead have this reflect reality and say that most users don't need to run this manually at all. Signed-off-by: Ævar Arnfjörð Bjarmason --- Documentation/git-gc.txt | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/Documentation/git-gc.txt b/Documentation/git-gc.txt index a7c1b0f60ed..cc82971022e 100644 --- a/Documentation/git-gc.txt +++ b/Documentation/git-gc.txt @@ -20,13 +20,17 @@ created from prior invocations of 'git add', packing refs, pruning reflog, rerere metadata or stale working trees. May also update ancillary indexes such as the commit-graph. -Users are encouraged to run this task on a regular basis within -each repository to maintain good disk space utilization and good -operating performance. +Most users should not have to run this command manually. When common +porcelain operations that create objects are run, such as +linkgit:git-commit[1] and linkgit:git-fetch[1], `git gc --auto` will +be run automatically. -Some git commands may automatically run 'git gc'; see the `--auto` flag -below for details. If you know what you're doing and all you want is to -disable this behavior permanently without further considerations, just do: +You should only need to run `git gc` manually when adding objects to a +repository without regularly running such porcelain commands. Another +use-case is wanting to do a one-off repository optimization. + +If you know what you're doing and all you want is to disable automatic +runs, do: ---------------------- $ git config --global gc.auto 0