From patchwork Thu May 11 18:10:31 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: John Cai X-Patchwork-Id: 13238338 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 188A4C7EE22 for ; Thu, 11 May 2023 18:11:07 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S239112AbjEKSLG (ORCPT ); Thu, 11 May 2023 14:11:06 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:38568 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S239109AbjEKSLE (ORCPT ); Thu, 11 May 2023 14:11:04 -0400 Received: from mail-wr1-x435.google.com (mail-wr1-x435.google.com [IPv6:2a00:1450:4864:20::435]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 1B7D9618E for ; Thu, 11 May 2023 11:10:41 -0700 (PDT) Received: by mail-wr1-x435.google.com with SMTP id ffacd0b85a97d-3078c092056so4283469f8f.1 for ; Thu, 11 May 2023 11:10:41 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1683828637; x=1686420637; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=uZhFDGmqjC6o6CL26mgnGBnxyvAceRWz2SgtOUWsswA=; b=OVhJMTalLwdJfIsgLR955xf6VbITq56dH1FFoRI+guzLPD8ghlzIlCmENTyDatNjjO kTXHiBZR5bo0VmwEq84MpxoVRa9ouC5T6sRp4i4kZXQBtB3tHpqKUNxqWOuuNDR/lbfI 0Z/tjhWkqkJATpIbB7neL5COOiysHwITyLrrzriVnjdfr3/7HMaFhaxpo4I/5QjWhT+N o+HH3+uTx3hFLoHAzSNrTNqjoH3v85vR8o+4KyyflZHgu8C0kiJLX0tbHiaSfH2Z9T9M GuU2e+V5r8EPH9YXWeLyzaBbbVZ94HAgMOnqstWWPsAs8Epnam0WNSplB8lMghd64xLp O/DA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683828637; x=1686420637; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=uZhFDGmqjC6o6CL26mgnGBnxyvAceRWz2SgtOUWsswA=; b=QlrTp8jXJ1R6IOEDVLh4UiP+T8q0TysbUcJ1Ph4vul15KAF1LqS4PTs3wN5l3ALRp0 1fAcLomiY9rPGapPMBKDoJlawA/+gEJcg6DciTutGN+e/YMP03AbUCbOa42AzUZcakNq GRO3A9K19X+66tQkqV9/sTm1FrvRAZKCpGA3+ew+eaqUSHH5amL+ejuY5HZ8tljY1tfd JIlc9Z0EUZvQI0mRbgF5uPEhfemqZciOB+TN7pylZATdIVTaN9BIcTX+wKOXvZYENSqz +8W53M0KeUWwZctqfxROHmU+6aI7R/Cwv0B7jQDDtPBt5sVF4cIDpu6AzVkpcH8Gh9rx 3gXQ== X-Gm-Message-State: AC+VfDxcA/F5B4VVQ7JLWM4Ls8N/LHpwm/RpsLUk60oBmX16kLhXZ1Bc t84Q16Ea4hrHEzwDzvl+nk0DpkvNg+M= X-Google-Smtp-Source: ACHHUZ5WyCXXfgs2TcgYQesCWY4rINIh/AvrOCX85Pm2oTlqAHOT6MagNNUF178lKwSsNDJZAmO+og== X-Received: by 2002:adf:f1c9:0:b0:2ce:aa2d:c625 with SMTP id z9-20020adff1c9000000b002ceaa2dc625mr14649527wro.22.1683828637202; Thu, 11 May 2023 11:10:37 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id p1-20020a5d4581000000b0030639a86f9dsm20968351wrq.51.2023.05.11.11.10.36 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 11 May 2023 11:10:37 -0700 (PDT) Message-Id: <0d462010b798f834fef55cc7aa767f3f2a177f91.1683828635.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Thu, 11 May 2023 18:10:31 +0000 Subject: [PATCH v3 1/4] docs: clarify git-pack-refs --all will pack all refs Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: Junio C Hamano , Christian Couder , John Cai , John Cai Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: John Cai From: John Cai --all packs not just branch tips but anything under refs/ with the exception of hidden refs and broken refs. Clarify this in the documentation. Signed-off-by: John Cai --- Documentation/git-pack-refs.txt | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/Documentation/git-pack-refs.txt b/Documentation/git-pack-refs.txt index 154081f2de2..e011e5fead3 100644 --- a/Documentation/git-pack-refs.txt +++ b/Documentation/git-pack-refs.txt @@ -49,10 +49,11 @@ OPTIONS The command by default packs all tags and refs that are already packed, and leaves other refs -alone. This is because branches are expected to be actively +alone. This is because branches are expected to be actively developed and packing their tips does not help performance. -This option causes branch tips to be packed as well. Useful for -a repository with many branches of historical interests. +This option causes all refs to be packed as well, with the exception of hidden +and broken refs. Useful for a repository with many branches of historical +interests. --no-prune:: From patchwork Thu May 11 18:10:32 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: John Cai X-Patchwork-Id: 13238340 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 78E0FC77B7F for ; Thu, 11 May 2023 18:11:10 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S239157AbjEKSLJ (ORCPT ); Thu, 11 May 2023 14:11:09 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:38588 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S238953AbjEKSLF (ORCPT ); Thu, 11 May 2023 14:11:05 -0400 Received: from mail-wm1-x32b.google.com (mail-wm1-x32b.google.com [IPv6:2a00:1450:4864:20::32b]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 4D17293FA for ; Thu, 11 May 2023 11:10:42 -0700 (PDT) Received: by mail-wm1-x32b.google.com with SMTP id 5b1f17b1804b1-3f315735514so295530335e9.1 for ; Thu, 11 May 2023 11:10:42 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1683828638; x=1686420638; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=GRaZaAF+L1F8sDwNorFoG6OrOLQZuDztZnzfFQULDYg=; b=IVcFqbI4Um4wK2Lomjev3i9F+A1/kmcqjHV0AjwMLLkCoseACrHNacQ7Z67ahbsPG9 3FPNOCX8pMTVLV2u++g8cnTZ0WqT8JW2S9bG/Q6TW2ef+OaoUAcROJu4vxsv9sELRboH G3UBn1FtcSrdyHm3NEuDxi4kuS4Zk9Dq60LrUgTruR1OTTJyp+NfFJ9/Xtvv/ljH5wQQ 0UdPxGx/8iLuNMlvjPc4G8Xkm0n2a6REFmkA4/APu/fptJiWcvw0UafJlHQayjdIrOTE mAI1g8jCzWyF9rDuvj/2KVNxaPRq8Tuf5nosm60sCdqM8vVUc6f1vJiD1Uj4bUIiSh8M aEmA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683828638; x=1686420638; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=GRaZaAF+L1F8sDwNorFoG6OrOLQZuDztZnzfFQULDYg=; b=N5uqq6+mtJ9KTKN76ks8yasltMAr9YE/c15STw+7Ty+V/iyu2glXmdXbelAkMGCqFY HtolsT77myLrBls7SNRPLAGV1eqS6Yye+/JIYvw0v92lDEzLfuB8Yrz5V2dCsKZ55Rqb JU2DVjK9lXNzRlEIXIpt2/f4UdyZ0KUg0nK7M0J+pF1rql4fX8yjXtEolPltBYrDObVI 4d6SR072xytyZrfIsejSstAF/ukRbRL62hgmIAy9fetr+xR3V5ON/OHnGj+Zyoo8mnxz jIEqX+uUkcw1TS8DhHQo/wBNKQW2MNuoYgPJLO9CzBqrhgHsfUEwkXrxL4TrL8kHUg9G 4lZA== X-Gm-Message-State: AC+VfDzMIB2GorSR1YvW+PU9yh/XngTBkfw9bhONxI2jcGQ2XLzx8pK7 MTiW5to5/HYb/4EQBdvese5BH86kFcU= X-Google-Smtp-Source: ACHHUZ4x+60nRTEvxpF2fJWrfXU8TBojkkcjuTHc6Ev1/F/YcLJWQQ6zfNn3wDLYw4m4bsk6cdf2XA== X-Received: by 2002:a05:600c:2197:b0:3f4:2158:28a0 with SMTP id e23-20020a05600c219700b003f4215828a0mr10434175wme.12.1683828637969; Thu, 11 May 2023 11:10:37 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id u5-20020a05600c210500b003f427cba193sm11245990wml.41.2023.05.11.11.10.37 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 11 May 2023 11:10:37 -0700 (PDT) Message-Id: <8c5c66a3050ee1c0ce8a48a088f5ecc2df7d1e3a.1683828635.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Thu, 11 May 2023 18:10:32 +0000 Subject: [PATCH v3 2/4] pack-refs: teach --exclude option to exclude refs from being packed Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: Junio C Hamano , Christian Couder , John Cai , John Cai Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: John Cai From: John Cai At GitLab, we have a system that creates ephemeral internal refs that don't live long before getting deleted. Having an option to exclude certain refs from a packed-refs file allows these internal references to be deleted much more efficiently. Add an --exclude option to the pack-refs builtin, and use the ref exclusions API to exclude certain refs from being packed into the final packed-refs file Signed-off-by: John Cai --- Documentation/git-pack-refs.txt | 12 +++++++++++- builtin/pack-refs.c | 20 ++++++++++++++++---- refs.c | 4 ++-- refs.h | 7 ++++++- refs/debug.c | 4 ++-- refs/files-backend.c | 16 ++++++++++------ refs/packed-backend.c | 2 +- refs/refs-internal.h | 3 ++- revision.h | 2 +- t/helper/test-ref-store.c | 3 ++- t/t3210-pack-refs.sh | 16 ++++++++++++++++ 11 files changed, 69 insertions(+), 20 deletions(-) diff --git a/Documentation/git-pack-refs.txt b/Documentation/git-pack-refs.txt index e011e5fead3..c0f7426e519 100644 --- a/Documentation/git-pack-refs.txt +++ b/Documentation/git-pack-refs.txt @@ -8,7 +8,7 @@ git-pack-refs - Pack heads and tags for efficient repository access SYNOPSIS -------- [verse] -'git pack-refs' [--all] [--no-prune] +'git pack-refs' [--all] [--no-prune] [--exclude ] DESCRIPTION ----------- @@ -60,6 +60,16 @@ interests. The command usually removes loose refs under `$GIT_DIR/refs` hierarchy after packing them. This option tells it not to. +--exclude :: + +Do not pack refs matching the given `glob(7)` pattern. Repetitions of this option +accumulate exclusion patterns. Use `--no-exclude` to clear and reset the list of +patterns. If a ref is already packed, including it with `--exclude` will not +unpack it. + +When used with `--all`, it will use the difference between the set of all refs, +and what is provided to `--exclude`. + BUGS ---- diff --git a/builtin/pack-refs.c b/builtin/pack-refs.c index 9833815fb30..1d1a64fe386 100644 --- a/builtin/pack-refs.c +++ b/builtin/pack-refs.c @@ -4,22 +4,34 @@ #include "parse-options.h" #include "refs.h" #include "repository.h" +#include "revision.h" static char const * const pack_refs_usage[] = { - N_("git pack-refs [--all] [--no-prune]"), + N_("git pack-refs [--all] [--no-prune] [--exclude ]"), NULL }; int cmd_pack_refs(int argc, const char **argv, const char *prefix) { unsigned int flags = PACK_REFS_PRUNE; + static struct ref_exclusions excludes = REF_EXCLUSIONS_INIT; + struct pack_refs_opts pack_refs_opts = {.exclusions = &excludes, .flags = flags}; + static struct string_list option_excluded_refs = STRING_LIST_INIT_NODUP; + struct string_list_item *item; + struct option opts[] = { - OPT_BIT(0, "all", &flags, N_("pack everything"), PACK_REFS_ALL), - OPT_BIT(0, "prune", &flags, N_("prune loose refs (default)"), PACK_REFS_PRUNE), + OPT_BIT(0, "all", &pack_refs_opts.flags, N_("pack everything"), PACK_REFS_ALL), + OPT_BIT(0, "prune", &pack_refs_opts.flags, N_("prune loose refs (default)"), PACK_REFS_PRUNE), + OPT_STRING_LIST(0, "exclude", &option_excluded_refs, N_("pattern"), + N_("references to exclude")), OPT_END(), }; git_config(git_default_config, NULL); if (parse_options(argc, argv, prefix, opts, pack_refs_usage, 0)) usage_with_options(pack_refs_usage, opts); - return refs_pack_refs(get_main_ref_store(the_repository), flags); + + for_each_string_list_item(item, &option_excluded_refs) + add_ref_exclusion(pack_refs_opts.exclusions, item->string); + + return refs_pack_refs(get_main_ref_store(the_repository), &pack_refs_opts); } diff --git a/refs.c b/refs.c index d2a98e1c21f..881a0da65cf 100644 --- a/refs.c +++ b/refs.c @@ -2132,9 +2132,9 @@ void base_ref_store_init(struct ref_store *refs, struct repository *repo, } /* backend functions */ -int refs_pack_refs(struct ref_store *refs, unsigned int flags) +int refs_pack_refs(struct ref_store *refs, struct pack_refs_opts *opts) { - return refs->be->pack_refs(refs, flags); + return refs->be->pack_refs(refs, opts); } int peel_iterated_oid(const struct object_id *base, struct object_id *peeled) diff --git a/refs.h b/refs.h index 123cfa44244..46020bd335c 100644 --- a/refs.h +++ b/refs.h @@ -63,6 +63,11 @@ struct worktree; #define RESOLVE_REF_NO_RECURSE 0x02 #define RESOLVE_REF_ALLOW_BAD_NAME 0x04 +struct pack_refs_opts { + unsigned int flags; + struct ref_exclusions *exclusions; +}; + const char *refs_resolve_ref_unsafe(struct ref_store *refs, const char *refname, int resolve_flags, @@ -405,7 +410,7 @@ void warn_dangling_symrefs(FILE *fp, const char *msg_fmt, * Write a packed-refs file for the current repository. * flags: Combination of the above PACK_REFS_* flags. */ -int refs_pack_refs(struct ref_store *refs, unsigned int flags); +int refs_pack_refs(struct ref_store *refs, struct pack_refs_opts *opts); /* * Setup reflog before using. Fill in err and return -1 on failure. diff --git a/refs/debug.c b/refs/debug.c index 6f11e6de46c..c0fa707a1da 100644 --- a/refs/debug.c +++ b/refs/debug.c @@ -123,10 +123,10 @@ static int debug_initial_transaction_commit(struct ref_store *refs, return res; } -static int debug_pack_refs(struct ref_store *ref_store, unsigned int flags) +static int debug_pack_refs(struct ref_store *ref_store, struct pack_refs_opts *opts) { struct debug_ref_store *drefs = (struct debug_ref_store *)ref_store; - int res = drefs->refs->be->pack_refs(drefs->refs, flags); + int res = drefs->refs->be->pack_refs(drefs->refs, opts); trace_printf_key(&trace_refs, "pack_refs: %d\n", res); return res; } diff --git a/refs/files-backend.c b/refs/files-backend.c index bca7b851c5a..76aebfde695 100644 --- a/refs/files-backend.c +++ b/refs/files-backend.c @@ -21,6 +21,7 @@ #include "../worktree.h" #include "../wrapper.h" #include "../write-or-die.h" +#include "../revision.h" /* * This backend uses the following flags in `ref_update::flags` for @@ -1175,15 +1176,18 @@ static void prune_refs(struct files_ref_store *refs, struct ref_to_prune **refs_ */ static int should_pack_ref(const char *refname, const struct object_id *oid, unsigned int ref_flags, - unsigned int pack_flags) + struct pack_refs_opts *opts) { /* Do not pack per-worktree refs: */ if (parse_worktree_ref(refname, NULL, NULL, NULL) != REF_WORKTREE_SHARED) return 0; + if (opts->exclusions && ref_excluded(opts->exclusions, refname)) + return 0; + /* Do not pack non-tags unless PACK_REFS_ALL is set: */ - if (!(pack_flags & PACK_REFS_ALL) && !starts_with(refname, "refs/tags/")) + if (!(opts->flags & PACK_REFS_ALL) && !starts_with(refname, "refs/tags/")) return 0; /* Do not pack symbolic refs: */ @@ -1197,7 +1201,8 @@ static int should_pack_ref(const char *refname, return 1; } -static int files_pack_refs(struct ref_store *ref_store, unsigned int flags) +static int files_pack_refs(struct ref_store *ref_store, + struct pack_refs_opts *opts) { struct files_ref_store *refs = files_downcast(ref_store, REF_STORE_WRITE | REF_STORE_ODB, @@ -1222,8 +1227,7 @@ static int files_pack_refs(struct ref_store *ref_store, unsigned int flags) * in the packed ref cache. If the reference should be * pruned, also add it to refs_to_prune. */ - if (!should_pack_ref(iter->refname, iter->oid, iter->flags, - flags)) + if (!should_pack_ref(iter->refname, iter->oid, iter->flags, opts)) continue; /* @@ -1237,7 +1241,7 @@ static int files_pack_refs(struct ref_store *ref_store, unsigned int flags) iter->refname, err.buf); /* Schedule the loose reference for pruning if requested. */ - if ((flags & PACK_REFS_PRUNE)) { + if ((opts->flags & PACK_REFS_PRUNE)) { struct ref_to_prune *n; FLEX_ALLOC_STR(n, name, iter->refname); oidcpy(&n->oid, iter->oid); diff --git a/refs/packed-backend.c b/refs/packed-backend.c index 5b412a133be..291e53f5cfe 100644 --- a/refs/packed-backend.c +++ b/refs/packed-backend.c @@ -1577,7 +1577,7 @@ static int packed_delete_refs(struct ref_store *ref_store, const char *msg, } static int packed_pack_refs(struct ref_store *ref_store UNUSED, - unsigned int flags UNUSED) + struct pack_refs_opts *pack_opts UNUSED) { /* * Packed refs are already packed. It might be that loose refs diff --git a/refs/refs-internal.h b/refs/refs-internal.h index a85d113123c..f72b7be8941 100644 --- a/refs/refs-internal.h +++ b/refs/refs-internal.h @@ -547,7 +547,8 @@ typedef int ref_transaction_commit_fn(struct ref_store *refs, struct ref_transaction *transaction, struct strbuf *err); -typedef int pack_refs_fn(struct ref_store *ref_store, unsigned int flags); +typedef int pack_refs_fn(struct ref_store *ref_store, + struct pack_refs_opts *opts); typedef int create_symref_fn(struct ref_store *ref_store, const char *ref_target, const char *refs_heads_master, diff --git a/revision.h b/revision.h index 31828748dc0..25776af3815 100644 --- a/revision.h +++ b/revision.h @@ -87,7 +87,7 @@ struct rev_cmdline_info { struct ref_exclusions { /* * Excluded refs is a list of wildmatch patterns. If any of the - * patterns matches, the reference will be excluded. + * patterns match, the reference will be excluded. */ struct string_list excluded_refs; diff --git a/t/helper/test-ref-store.c b/t/helper/test-ref-store.c index 6d8f844e9c7..de4197708d9 100644 --- a/t/helper/test-ref-store.c +++ b/t/helper/test-ref-store.c @@ -116,8 +116,9 @@ static struct flag_definition pack_flags[] = { FLAG_DEF(PACK_REFS_PRUNE), static int cmd_pack_refs(struct ref_store *refs, const char **argv) { unsigned int flags = arg_flags(*argv++, "flags", pack_flags); + struct pack_refs_opts pack_opts = { .flags = flags }; - return refs_pack_refs(refs, flags); + return refs_pack_refs(refs, &pack_opts); } static int cmd_create_symref(struct ref_store *refs, const char **argv) diff --git a/t/t3210-pack-refs.sh b/t/t3210-pack-refs.sh index 07a0ff93def..ddfc1b6e5f1 100755 --- a/t/t3210-pack-refs.sh +++ b/t/t3210-pack-refs.sh @@ -108,6 +108,22 @@ test_expect_success \ git branch -d n/o/p && git branch n' +test_expect_success 'test excluded refs are not packed' ' + git branch dont_pack1 && + git branch dont_pack2 && + git branch pack_this && + git pack-refs --all --exclude "refs/heads/dont_pack*" && + test -f .git/refs/heads/dont_pack1 && + test -f .git/refs/heads/dont_pack2 && + ! test -f ./git/refs/heads/pack_this' + +test_expect_success 'test --no-exclude refs clears excluded refs' ' + git branch dont_pack3 && + git branch dont_pack4 && + git pack-refs --all --exclude "refs/heads/dont_pack*" --no-exclude && + ! test -f .git/refs/heads/dont_pack3 && + ! test -f .git/refs/heads/dont_pack4' + test_expect_success \ 'see if up-to-date packed refs are preserved' \ 'git branch q && From patchwork Thu May 11 18:10:33 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: John Cai X-Patchwork-Id: 13238341 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 3109EC7EE25 for ; Thu, 11 May 2023 18:11:12 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S238720AbjEKSLK (ORCPT ); Thu, 11 May 2023 14:11:10 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:38596 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S238991AbjEKSLF (ORCPT ); Thu, 11 May 2023 14:11:05 -0400 Received: from mail-wr1-x42d.google.com (mail-wr1-x42d.google.com [IPv6:2a00:1450:4864:20::42d]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 4993C1FD6 for ; Thu, 11 May 2023 11:10:43 -0700 (PDT) Received: by mail-wr1-x42d.google.com with SMTP id ffacd0b85a97d-306281edf15so8439833f8f.1 for ; Thu, 11 May 2023 11:10:43 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1683828638; x=1686420638; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=M4STwXsYC5zaqNwPZjors7t5vDArRyXy8FMMZAV/Z6w=; b=X8C4wjFlui8S3vT3qGSABfbQQmky8PNgig4PkqlbZAmOvLgvkP6FoUtvLN4kRJs3Ep PJV8r3CUf8wC21Eq31lTtgynNjzCV0FgKQbzT4eEndbJLI6ylM07QO0sWfZCDictSePL gNEcscHbzZKbsW2tfCAQn37jcj9hfwgpg5woF+0BIYMyviV873XLq6PmwFLhulOGsFuy Z32QxKTUMYw68PEN7KIU19YAFNUmWqOTwBw4sRUN+BKkH7UsCHXveIK+WaE8oMcPpC5b 0ui+JrsKdDw3OxyLVh4lp0A06J2IF52Ol/9WHDdXubxw6HfvYgrK/FZW8nT11Je+d7T4 jyRg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683828638; x=1686420638; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=M4STwXsYC5zaqNwPZjors7t5vDArRyXy8FMMZAV/Z6w=; b=d3eNKd7tOYSkTBnsy+OtHFcR2tmvpAfXlapFky8FjDaRrJ8yacocAy6NUVNq4Yd4a9 sQHb688qS0vhpDyLnkMmU+lAYnR/Ks2Gl9w35zt6eIIdK6oBZF7eNsAnAKwe4olrF4O/ xhn3/eYHwi6rU9Qcgr0bS6+poQs6dT9LFOA6xskvjMUtNzzC0yrg4g6rHJIp0KvHAroB agPt9hrtZM7d9Zv8pDRXobuaTPDBjMZFDylPTj9tJwDSaig+pLWPwkEzBxblJp3phUDe xzJG0HL/4LrqemhS9TtcyRx4qb3gKrPS+kwsY8yb3CP/S/Wwj0KY+7Xzgri+3GpFKX21 XPsg== X-Gm-Message-State: AC+VfDyPgjrGB1fgMT3RQtp8/QhxaI9+g7RESloXTL4nf+MPRl9AWXEg 6W9O/guP4fS4b3ZLqL4y0hmcWU3zmg4= X-Google-Smtp-Source: ACHHUZ7WyTn2gu627H1ZJPyw2XziovjFrodUD/VI3UH1Y3xTp7AOMdgaO1w7/5S2zhk7f8XPUhs6+Q== X-Received: by 2002:a5d:5143:0:b0:306:3bfb:fe94 with SMTP id u3-20020a5d5143000000b003063bfbfe94mr15521533wrt.53.1683828638495; Thu, 11 May 2023 11:10:38 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id f5-20020adff985000000b002fda1b12a0bsm21342315wrr.2.2023.05.11.11.10.38 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 11 May 2023 11:10:38 -0700 (PDT) Message-Id: <0a0693ad612755e675861dfa5a660baf8d325ed0.1683828635.git.gitgitgadget@gmail.com> In-Reply-To: References: Date: Thu, 11 May 2023 18:10:33 +0000 Subject: [PATCH v3 3/4] revision: modify ref_exclusions to handle inclusions Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: Junio C Hamano , Christian Couder , John Cai , John Cai Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: John Cai From: John Cai The ref_exclusions API provides the ability to check if certain refs are to be excluded. We can easily extend this API to check if certain refs are included, which a subsequent commit will make use of. Rename ref_exclusions to ref_visibility and add a member to keep track of inclusions. Add add_ref_inclusion(), ref_included() to be used for refs to explicitly include. Signed-off-by: John Cai --- builtin/pack-refs.c | 6 ++-- builtin/rev-parse.c | 18 +++++------ refs.h | 2 +- refs/files-backend.c | 2 +- revision.c | 71 +++++++++++++++++++++++++++----------------- revision.h | 26 ++++++++++------ 6 files changed, 75 insertions(+), 50 deletions(-) diff --git a/builtin/pack-refs.c b/builtin/pack-refs.c index 1d1a64fe386..2464575a665 100644 --- a/builtin/pack-refs.c +++ b/builtin/pack-refs.c @@ -14,8 +14,8 @@ static char const * const pack_refs_usage[] = { int cmd_pack_refs(int argc, const char **argv, const char *prefix) { unsigned int flags = PACK_REFS_PRUNE; - static struct ref_exclusions excludes = REF_EXCLUSIONS_INIT; - struct pack_refs_opts pack_refs_opts = {.exclusions = &excludes, .flags = flags}; + static struct ref_visibility visibility = REF_VISIBILITY_INIT; + struct pack_refs_opts pack_refs_opts = {.visibility = &visibility, .flags = flags}; static struct string_list option_excluded_refs = STRING_LIST_INIT_NODUP; struct string_list_item *item; @@ -31,7 +31,7 @@ int cmd_pack_refs(int argc, const char **argv, const char *prefix) usage_with_options(pack_refs_usage, opts); for_each_string_list_item(item, &option_excluded_refs) - add_ref_exclusion(pack_refs_opts.exclusions, item->string); + add_ref_exclusion(pack_refs_opts.visibility, item->string); return refs_pack_refs(get_main_ref_store(the_repository), &pack_refs_opts); } diff --git a/builtin/rev-parse.c b/builtin/rev-parse.c index 852e49e3403..9036d8876fc 100644 --- a/builtin/rev-parse.c +++ b/builtin/rev-parse.c @@ -46,7 +46,7 @@ static int abbrev_ref_strict; static int output_sq; static int stuck_long; -static struct ref_exclusions ref_excludes = REF_EXCLUSIONS_INIT; +static struct ref_visibility ref_visibility = REF_VISIBILITY_INIT; /* * Some arguments are relevant "revision" arguments, @@ -208,7 +208,7 @@ static int show_default(void) static int show_reference(const char *refname, const struct object_id *oid, int flag UNUSED, void *cb_data UNUSED) { - if (ref_excluded(&ref_excludes, refname)) + if (ref_excluded(&ref_visibility, refname)) return 0; show_rev(NORMAL, oid, refname); return 0; @@ -596,7 +596,7 @@ static void handle_ref_opt(const char *pattern, const char *prefix) for_each_glob_ref_in(show_reference, pattern, prefix, NULL); else for_each_ref_in(prefix, show_reference, NULL); - clear_ref_exclusions(&ref_excludes); + clear_ref_visibility(&ref_visibility); } enum format_type { @@ -874,7 +874,7 @@ int cmd_rev_parse(int argc, const char **argv, const char *prefix) } if (!strcmp(arg, "--all")) { for_each_ref(show_reference, NULL); - clear_ref_exclusions(&ref_excludes); + clear_ref_visibility(&ref_visibility); continue; } if (skip_prefix(arg, "--disambiguate=", &arg)) { @@ -888,13 +888,13 @@ int cmd_rev_parse(int argc, const char **argv, const char *prefix) continue; } if (opt_with_value(arg, "--branches", &arg)) { - if (ref_excludes.hidden_refs_configured) + if (ref_visibility.hidden_refs_configured) return error(_("--exclude-hidden cannot be used together with --branches")); handle_ref_opt(arg, "refs/heads/"); continue; } if (opt_with_value(arg, "--tags", &arg)) { - if (ref_excludes.hidden_refs_configured) + if (ref_visibility.hidden_refs_configured) return error(_("--exclude-hidden cannot be used together with --tags")); handle_ref_opt(arg, "refs/tags/"); continue; @@ -904,17 +904,17 @@ int cmd_rev_parse(int argc, const char **argv, const char *prefix) continue; } if (opt_with_value(arg, "--remotes", &arg)) { - if (ref_excludes.hidden_refs_configured) + if (ref_visibility.hidden_refs_configured) return error(_("--exclude-hidden cannot be used together with --remotes")); handle_ref_opt(arg, "refs/remotes/"); continue; } if (skip_prefix(arg, "--exclude=", &arg)) { - add_ref_exclusion(&ref_excludes, arg); + add_ref_exclusion(&ref_visibility, arg); continue; } if (skip_prefix(arg, "--exclude-hidden=", &arg)) { - exclude_hidden_refs(&ref_excludes, arg); + exclude_hidden_refs(&ref_visibility, arg); continue; } if (!strcmp(arg, "--show-toplevel")) { diff --git a/refs.h b/refs.h index 46020bd335c..57949a1726b 100644 --- a/refs.h +++ b/refs.h @@ -65,7 +65,7 @@ struct worktree; struct pack_refs_opts { unsigned int flags; - struct ref_exclusions *exclusions; + struct ref_visibility *visibility; }; const char *refs_resolve_ref_unsafe(struct ref_store *refs, diff --git a/refs/files-backend.c b/refs/files-backend.c index 76aebfde695..3ef19199788 100644 --- a/refs/files-backend.c +++ b/refs/files-backend.c @@ -1183,7 +1183,7 @@ static int should_pack_ref(const char *refname, REF_WORKTREE_SHARED) return 0; - if (opts->exclusions && ref_excluded(opts->exclusions, refname)) + if (opts->visibility && ref_excluded(opts->visibility, refname)) return 0; /* Do not pack non-tags unless PACK_REFS_ALL is set: */ diff --git a/revision.c b/revision.c index b33cc1d106a..d59cd728e9e 100644 --- a/revision.c +++ b/revision.c @@ -1533,54 +1533,71 @@ static void add_rev_cmdline_list(struct rev_info *revs, } } -int ref_excluded(const struct ref_exclusions *exclusions, const char *path) +static int ref_matched(const char *path, + const struct string_list *l, + const struct string_list *hidden_refs) { const char *stripped_path = strip_namespace(path); struct string_list_item *item; - for_each_string_list_item(item, &exclusions->excluded_refs) { + for_each_string_list_item(item, l) { if (!wildmatch(item->string, path, 0)) return 1; } - if (ref_is_hidden(stripped_path, path, &exclusions->hidden_refs)) + if (ref_is_hidden(stripped_path, path, hidden_refs)) return 1; return 0; } -void init_ref_exclusions(struct ref_exclusions *exclusions) +int ref_excluded(const struct ref_visibility *visibility, const char *path) { - struct ref_exclusions blank = REF_EXCLUSIONS_INIT; - memcpy(exclusions, &blank, sizeof(*exclusions)); + return ref_matched(path, &visibility->excluded_refs, &visibility->hidden_refs); } -void clear_ref_exclusions(struct ref_exclusions *exclusions) +int ref_included(const struct ref_visibility *visibility, const char *path) { - string_list_clear(&exclusions->excluded_refs, 0); - string_list_clear(&exclusions->hidden_refs, 0); - exclusions->hidden_refs_configured = 0; + return ref_matched(path, &visibility->included_refs, &visibility->hidden_refs); } -void add_ref_exclusion(struct ref_exclusions *exclusions, const char *exclude) +void init_ref_visibility(struct ref_visibility *visibility) { - string_list_append(&exclusions->excluded_refs, exclude); + struct ref_visibility blank = REF_VISIBILITY_INIT; + memcpy(visibility, &blank, sizeof(*visibility)); +} + +void clear_ref_visibility(struct ref_visibility *visibility) +{ + string_list_clear(&visibility->excluded_refs, 0); + string_list_clear(&visibility->hidden_refs, 0); + visibility->hidden_refs_configured = 0; +} + +void add_ref_exclusion(struct ref_visibility *visibility, const char *exclude) +{ + string_list_append(&visibility->excluded_refs, exclude); +} + +void add_ref_inclusion(struct ref_visibility *visibility, const char *include) +{ + string_list_append(&visibility->included_refs, include); } struct exclude_hidden_refs_cb { - struct ref_exclusions *exclusions; + struct ref_visibility *visibility; const char *section; }; static int hide_refs_config(const char *var, const char *value, void *cb_data) { struct exclude_hidden_refs_cb *cb = cb_data; - cb->exclusions->hidden_refs_configured = 1; + cb->visibility->hidden_refs_configured = 1; return parse_hide_refs_config(var, value, cb->section, - &cb->exclusions->hidden_refs); + &cb->visibility->hidden_refs); } -void exclude_hidden_refs(struct ref_exclusions *exclusions, const char *section) +void exclude_hidden_refs(struct ref_visibility *visibility, const char *section) { struct exclude_hidden_refs_cb cb; @@ -1588,10 +1605,10 @@ void exclude_hidden_refs(struct ref_exclusions *exclusions, const char *section) strcmp(section, "uploadpack")) die(_("unsupported section for hidden refs: %s"), section); - if (exclusions->hidden_refs_configured) + if (visibility->hidden_refs_configured) die(_("--exclude-hidden= passed more than once")); - cb.exclusions = exclusions; + cb.visibility = visibility; cb.section = section; git_config(hide_refs_config, &cb); @@ -1935,7 +1952,7 @@ void repo_init_revisions(struct repository *r, init_display_notes(&revs->notes_opt); list_objects_filter_init(&revs->filter); - init_ref_exclusions(&revs->ref_excludes); + init_ref_visibility(&revs->ref_excludes); } static void add_pending_commit_list(struct rev_info *revs, @@ -2724,12 +2741,12 @@ static int handle_revision_pseudo_opt(struct rev_info *revs, init_all_refs_cb(&cb, revs, *flags); other_head_refs(handle_one_ref, &cb); } - clear_ref_exclusions(&revs->ref_excludes); + clear_ref_visibility(&revs->ref_excludes); } else if (!strcmp(arg, "--branches")) { if (revs->ref_excludes.hidden_refs_configured) return error(_("--exclude-hidden cannot be used together with --branches")); handle_refs(refs, revs, *flags, refs_for_each_branch_ref); - clear_ref_exclusions(&revs->ref_excludes); + clear_ref_visibility(&revs->ref_excludes); } else if (!strcmp(arg, "--bisect")) { read_bisect_terms(&term_bad, &term_good); handle_refs(refs, revs, *flags, for_each_bad_bisect_ref); @@ -2740,17 +2757,17 @@ static int handle_revision_pseudo_opt(struct rev_info *revs, if (revs->ref_excludes.hidden_refs_configured) return error(_("--exclude-hidden cannot be used together with --tags")); handle_refs(refs, revs, *flags, refs_for_each_tag_ref); - clear_ref_exclusions(&revs->ref_excludes); + clear_ref_visibility(&revs->ref_excludes); } else if (!strcmp(arg, "--remotes")) { if (revs->ref_excludes.hidden_refs_configured) return error(_("--exclude-hidden cannot be used together with --remotes")); handle_refs(refs, revs, *flags, refs_for_each_remote_ref); - clear_ref_exclusions(&revs->ref_excludes); + clear_ref_visibility(&revs->ref_excludes); } else if ((argcount = parse_long_opt("glob", argv, &optarg))) { struct all_refs_cb cb; init_all_refs_cb(&cb, revs, *flags); for_each_glob_ref(handle_one_ref, optarg, &cb); - clear_ref_exclusions(&revs->ref_excludes); + clear_ref_visibility(&revs->ref_excludes); return argcount; } else if ((argcount = parse_long_opt("exclude", argv, &optarg))) { add_ref_exclusion(&revs->ref_excludes, optarg); @@ -2764,21 +2781,21 @@ static int handle_revision_pseudo_opt(struct rev_info *revs, return error(_("--exclude-hidden cannot be used together with --branches")); init_all_refs_cb(&cb, revs, *flags); for_each_glob_ref_in(handle_one_ref, optarg, "refs/heads/", &cb); - clear_ref_exclusions(&revs->ref_excludes); + clear_ref_visibility(&revs->ref_excludes); } else if (skip_prefix(arg, "--tags=", &optarg)) { struct all_refs_cb cb; if (revs->ref_excludes.hidden_refs_configured) return error(_("--exclude-hidden cannot be used together with --tags")); init_all_refs_cb(&cb, revs, *flags); for_each_glob_ref_in(handle_one_ref, optarg, "refs/tags/", &cb); - clear_ref_exclusions(&revs->ref_excludes); + clear_ref_visibility(&revs->ref_excludes); } else if (skip_prefix(arg, "--remotes=", &optarg)) { struct all_refs_cb cb; if (revs->ref_excludes.hidden_refs_configured) return error(_("--exclude-hidden cannot be used together with --remotes")); init_all_refs_cb(&cb, revs, *flags); for_each_glob_ref_in(handle_one_ref, optarg, "refs/remotes/", &cb); - clear_ref_exclusions(&revs->ref_excludes); + clear_ref_visibility(&revs->ref_excludes); } else if (!strcmp(arg, "--reflog")) { add_reflogs_to_pending(revs, *flags); } else if (!strcmp(arg, "--indexed-objects")) { diff --git a/revision.h b/revision.h index 25776af3815..296c520a003 100644 --- a/revision.h +++ b/revision.h @@ -84,7 +84,12 @@ struct rev_cmdline_info { } *rev; }; -struct ref_exclusions { +struct ref_visibility { + /* + * Included refs is a list of wildmatch patterns. If any of the + * patterns match, the reference will be included. + */ + struct string_list included_refs; /* * Excluded refs is a list of wildmatch patterns. If any of the * patterns match, the reference will be excluded. @@ -106,9 +111,10 @@ struct ref_exclusions { }; /** - * Initialize a `struct ref_exclusions` with a macro. + * Initialize a `struct ref_visibility` with a macro. */ -#define REF_EXCLUSIONS_INIT { \ +#define REF_VISIBILITY_INIT { \ + .included_refs = STRING_LIST_INIT_DUP, \ .excluded_refs = STRING_LIST_INIT_DUP, \ .hidden_refs = STRING_LIST_INIT_DUP, \ } @@ -135,7 +141,7 @@ struct rev_info { struct list_objects_filter_options filter; /* excluding from --branches, --refs, etc. expansion */ - struct ref_exclusions ref_excludes; + struct ref_visibility ref_excludes; /* Basic information */ const char *prefix; @@ -487,11 +493,13 @@ void show_object_with_name(FILE *, struct object *, const char *); * Helpers to check if a reference should be excluded. */ -int ref_excluded(const struct ref_exclusions *exclusions, const char *path); -void init_ref_exclusions(struct ref_exclusions *); -void clear_ref_exclusions(struct ref_exclusions *); -void add_ref_exclusion(struct ref_exclusions *, const char *exclude); -void exclude_hidden_refs(struct ref_exclusions *, const char *section); +int ref_excluded(const struct ref_visibility *exclusions, const char *path); +int ref_included(const struct ref_visibility *exclusions, const char *path); +void init_ref_visibility(struct ref_visibility *); +void clear_ref_visibility(struct ref_visibility *); +void add_ref_exclusion(struct ref_visibility *, const char *exclude); +void add_ref_inclusion(struct ref_visibility *, const char *exclude); +void exclude_hidden_refs(struct ref_visibility *, const char *section); /** * This function can be used if you want to add commit objects as revision From patchwork Thu May 11 18:10:34 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: John Cai X-Patchwork-Id: 13238342 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id A44DBC7EE24 for ; Thu, 11 May 2023 18:11:13 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S239172AbjEKSLM (ORCPT ); Thu, 11 May 2023 14:11:12 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:38610 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S239097AbjEKSLF (ORCPT ); Thu, 11 May 2023 14:11:05 -0400 Received: from mail-wm1-x329.google.com (mail-wm1-x329.google.com [IPv6:2a00:1450:4864:20::329]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 574F859C9 for ; Thu, 11 May 2023 11:10:43 -0700 (PDT) Received: by mail-wm1-x329.google.com with SMTP id 5b1f17b1804b1-3f42c865535so35010495e9.1 for ; Thu, 11 May 2023 11:10:43 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1683828639; x=1686420639; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:from:to:cc:subject:date :message-id:reply-to; bh=owB2XbBuAy7BfVLhS6ZUa1LnzDFPKxnqC/ILRkr5XeY=; b=VXQyJWdsG0L7Y1GGNlAO+VD8Di4ZVLPfgHsYRRxnwlQp+L7Hc0wVN/E7yW6amQOWPJ xAWrz+LsFXP8Cf/6fcGG/CP/2iAwooqIW+qptqaR7lT+NxOL6JdloA80eH5mCn95CN48 gQYl/QljrUiBpVGFMlQszvPMqhQf3tUwozO1MPCJqPB2X5ptdYp2IyvxNEt/KzWMd/Bu fJ1f759PhUuA+4KWusapAcRaqYUDXwsGLUUgdj9uNGDKmJgkiheAS3Bdu3alTrsBFe2W Pgt1mfEOb99h16ZCO8ncfFyrqFKFyqCdSETIch2Fpjli03rXGWw+jnD4CWkCaQey51yy kqvg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683828639; x=1686420639; h=cc:to:mime-version:content-transfer-encoding:fcc:subject:date:from :references:in-reply-to:message-id:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=owB2XbBuAy7BfVLhS6ZUa1LnzDFPKxnqC/ILRkr5XeY=; b=H7o9XlPCwRKgt7x+DdIuxDJ+9m8VMocay9r7xg7GBu5q7rxkEHsHzT1NBX4dJw5FnM e11lL8T2KGtrmbzxAz5Y98JAo890gmb13pZa+wCCtvIkRNedyN4DirPqH7ZLmM02LqxK PAB+FmgXjouq5PXoZv3CndeYvXdH9ShFkRjYn9pvtlO3Zd4j/0guBiHlyrrJXnHeZdV9 EEPKm06x5PLtJaj1NEVvv03d7xRvkCW3PdH3G8q0zBqYN7J2kECMmo7Fhf8svWHkjX9e ON5r1nqRUmoCiz4l+nOmc1olOw1H9VHt/bAydsx9pXlCD82EeswWCnkJp6NAf51+mBVd AG8Q== X-Gm-Message-State: AC+VfDwCvpLb+ckDdk9aChVxCqjRHPpCJUPJ6W1fQxip+f90gPl6iJ62 tfOi3zp9YyV2t0/w9jmkLPbRn79iWg0= X-Google-Smtp-Source: ACHHUZ79rMgoTL0Oh4lOYc0QZGN/NvjxSxl1h2O34/PTCzMrWPUEDNcMaH3hvw/lRYN6E44FYh1+kg== X-Received: by 2002:a5d:4008:0:b0:306:39e5:f338 with SMTP id n8-20020a5d4008000000b0030639e5f338mr13146618wrp.62.1683828639303; Thu, 11 May 2023 11:10:39 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id c3-20020a7bc843000000b003f31d44f0cbsm26535845wml.29.2023.05.11.11.10.38 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 11 May 2023 11:10:38 -0700 (PDT) Message-Id: In-Reply-To: References: Date: Thu, 11 May 2023 18:10:34 +0000 Subject: [PATCH v3 4/4] pack-refs: teach pack-refs --include option Fcc: Sent MIME-Version: 1.0 To: git@vger.kernel.org Cc: Junio C Hamano , Christian Couder , John Cai , John Cai Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: John Cai From: John Cai Allow users to be more selective over which refs to pack by adding an --include option to git-pack-refs. The existing options allow some measure of selectivity. By default git-pack-refs packs all tags. --all can be used to include all refs, and the previous commit added the ability to exclude certain refs with --exclude. While these knobs give the user some selection over which refs to pack, it could be useful to give more control. For instance, a repository may have a set of branches that are rarely updated and would benefit from being packed. --include would allow the user to easily include a set of branches to be packed while leaving everything else unpacked. Signed-off-by: John Cai --- Documentation/git-pack-refs.txt | 14 +++++++++++++- builtin/pack-refs.c | 18 ++++++++++++++++-- refs/files-backend.c | 15 +++++++-------- t/helper/test-ref-store.c | 8 +++++++- t/t3210-pack-refs.sh | 21 +++++++++++++++++++++ 5 files changed, 64 insertions(+), 12 deletions(-) diff --git a/Documentation/git-pack-refs.txt b/Documentation/git-pack-refs.txt index c0f7426e519..85874a5f5dc 100644 --- a/Documentation/git-pack-refs.txt +++ b/Documentation/git-pack-refs.txt @@ -8,7 +8,7 @@ git-pack-refs - Pack heads and tags for efficient repository access SYNOPSIS -------- [verse] -'git pack-refs' [--all] [--no-prune] [--exclude ] +'git pack-refs' [--all] [--no-prune] [--include ] [--exclude ] DESCRIPTION ----------- @@ -60,6 +60,15 @@ interests. The command usually removes loose refs under `$GIT_DIR/refs` hierarchy after packing them. This option tells it not to. +--include :: + +Pack refs based on a `glob(7)` pattern. Repetitions of this option +accumulate inclusion patterns. If a ref is both included in `--include` and +`--exclude`, `--exclude` takes precedence. Using `--include` will preclude all +tags from being included by default. Symbolic refs and broken refs will never +be packed. When used with `--all`, it will be a noop. Use `--no-include` to clear +and reset the list of patterns. + --exclude :: Do not pack refs matching the given `glob(7)` pattern. Repetitions of this option @@ -70,6 +79,9 @@ unpack it. When used with `--all`, it will use the difference between the set of all refs, and what is provided to `--exclude`. +When used with `--include`, refs provided to `--include`, minus refs that are +provided to `--exclude` will be packed. + BUGS ---- diff --git a/builtin/pack-refs.c b/builtin/pack-refs.c index 2464575a665..5062206f22e 100644 --- a/builtin/pack-refs.c +++ b/builtin/pack-refs.c @@ -5,9 +5,10 @@ #include "refs.h" #include "repository.h" #include "revision.h" +#include "trace.h" static char const * const pack_refs_usage[] = { - N_("git pack-refs [--all] [--no-prune] [--exclude ]"), + N_("git pack-refs [--all] [--no-prune] [--include ] [--exclude ]"), NULL }; @@ -15,13 +16,17 @@ int cmd_pack_refs(int argc, const char **argv, const char *prefix) { unsigned int flags = PACK_REFS_PRUNE; static struct ref_visibility visibility = REF_VISIBILITY_INIT; - struct pack_refs_opts pack_refs_opts = {.visibility = &visibility, .flags = flags}; + struct pack_refs_opts pack_refs_opts = { .visibility = &visibility, + .flags = flags }; static struct string_list option_excluded_refs = STRING_LIST_INIT_NODUP; + static struct string_list option_included_refs = STRING_LIST_INIT_NODUP; struct string_list_item *item; struct option opts[] = { OPT_BIT(0, "all", &pack_refs_opts.flags, N_("pack everything"), PACK_REFS_ALL), OPT_BIT(0, "prune", &pack_refs_opts.flags, N_("prune loose refs (default)"), PACK_REFS_PRUNE), + OPT_STRING_LIST(0, "include", &option_included_refs, N_("pattern"), + N_("references to include")), OPT_STRING_LIST(0, "exclude", &option_excluded_refs, N_("pattern"), N_("references to exclude")), OPT_END(), @@ -33,5 +38,14 @@ int cmd_pack_refs(int argc, const char **argv, const char *prefix) for_each_string_list_item(item, &option_excluded_refs) add_ref_exclusion(pack_refs_opts.visibility, item->string); + for_each_string_list_item(item, &option_included_refs) + add_ref_inclusion(pack_refs_opts.visibility, item->string); + + if (pack_refs_opts.flags & PACK_REFS_ALL) + add_ref_inclusion(pack_refs_opts.visibility, "*"); + + if (!pack_refs_opts.visibility->included_refs.nr) + add_ref_inclusion(pack_refs_opts.visibility, "refs/tags/*"); + return refs_pack_refs(get_main_ref_store(the_repository), &pack_refs_opts); } diff --git a/refs/files-backend.c b/refs/files-backend.c index 3ef19199788..c669cf8001a 100644 --- a/refs/files-backend.c +++ b/refs/files-backend.c @@ -1183,13 +1183,6 @@ static int should_pack_ref(const char *refname, REF_WORKTREE_SHARED) return 0; - if (opts->visibility && ref_excluded(opts->visibility, refname)) - return 0; - - /* Do not pack non-tags unless PACK_REFS_ALL is set: */ - if (!(opts->flags & PACK_REFS_ALL) && !starts_with(refname, "refs/tags/")) - return 0; - /* Do not pack symbolic refs: */ if (ref_flags & REF_ISSYMREF) return 0; @@ -1198,7 +1191,13 @@ static int should_pack_ref(const char *refname, if (!ref_resolves_to_object(refname, the_repository, oid, ref_flags)) return 0; - return 1; + if (opts->visibility && ref_excluded(opts->visibility, refname)) + return 0; + + if (opts->visibility && ref_included(opts->visibility, refname)) + return 1; + + return 0; } static int files_pack_refs(struct ref_store *ref_store, diff --git a/t/helper/test-ref-store.c b/t/helper/test-ref-store.c index de4197708d9..0dec1223362 100644 --- a/t/helper/test-ref-store.c +++ b/t/helper/test-ref-store.c @@ -5,6 +5,7 @@ #include "worktree.h" #include "object-store.h" #include "repository.h" +#include "revision.h" struct flag_definition { const char *name; @@ -116,7 +117,12 @@ static struct flag_definition pack_flags[] = { FLAG_DEF(PACK_REFS_PRUNE), static int cmd_pack_refs(struct ref_store *refs, const char **argv) { unsigned int flags = arg_flags(*argv++, "flags", pack_flags); - struct pack_refs_opts pack_opts = { .flags = flags }; + static struct ref_visibility visibility = REF_VISIBILITY_INIT; + struct pack_refs_opts pack_opts = { .flags = flags, + .visibility = &visibility }; + + if (pack_opts.flags & PACK_REFS_ALL) + add_ref_inclusion(pack_opts.visibility, "*"); return refs_pack_refs(refs, &pack_opts); } diff --git a/t/t3210-pack-refs.sh b/t/t3210-pack-refs.sh index ddfc1b6e5f1..9ff6326b646 100755 --- a/t/t3210-pack-refs.sh +++ b/t/t3210-pack-refs.sh @@ -124,6 +124,27 @@ test_expect_success 'test --no-exclude refs clears excluded refs' ' ! test -f .git/refs/heads/dont_pack3 && ! test -f .git/refs/heads/dont_pack4' +test_expect_success 'test only included refs are packed' ' + git branch pack_this1 && + git branch pack_this2 && + git tag dont_pack5 && + git pack-refs --include "refs/heads/pack_this*" && + test -f .git/refs/tags/dont_pack5 && + ! test -f ./git/refs/heads/pack_this1 && + ! test -f ./git/refs/heads/pack_this2' + +test_expect_success 'test --no-include refs clears included refs' ' + git branch pack1 && + git branch pack2 && + git pack-refs --include "refs/heads/pack*" --no-include && + test -f .git/refs/heads/pack1 && + test -f .git/refs/heads/pack2' + +test_expect_success 'test --exclude takes precedence over --include' ' + git branch dont_pack5 && + git pack-refs --include "refs/heads/pack*" --exclude "refs/heads/pack*" && + test -f .git/refs/heads/dont_pack5' + test_expect_success \ 'see if up-to-date packed refs are preserved' \ 'git branch q &&