From: "John Cai via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: John Cai <johncai86@gmail.com>, John Cai <johncai86@gmail.com>
Subject: [PATCH] show-ref: add --unresolved option
Date: Mon, 04 Mar 2024 22:51:58 +0000 [thread overview]
Message-ID: <pull.1684.git.git.1709592718743.gitgitgadget@gmail.com> (raw)
From: John Cai <johncai86@gmail.com>
For reftable development, it would be handy to have a tool to provide
the direct value of any ref whether it be a symbolic ref or not.
Currently there is git-symbolic-ref, which only works for symbolic refs,
and git-rev-parse, which will resolve the ref. Let's add a --unresolved
option that will only take one ref and return whatever it points to
without dereferencing it.
Signed-off-by: John Cai <johncai86@gmail.com>
---
show-ref: add --unresolved option
For reftable development, it would be handy to have a tool to provide
the direct value of any ref whether it be a symbolic ref or not.
Currently there is git-symbolic-ref, which only works for symbolic refs,
and git-rev-parse, which will resolve the ref. Let's add a --unresolved
option that will only take one ref and return whatever it points to
without dereferencing it.
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1684%2Fjohn-cai%2Fjc%2Fshow-ref-direct-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1684/john-cai/jc/show-ref-direct-v1
Pull-Request: https://github.com/git/git/pull/1684
Documentation/git-show-ref.txt | 8 ++++++
builtin/show-ref.c | 33 ++++++++++++++++--------
t/t1403-show-ref.sh | 47 ++++++++++++++++++++++++++++++++++
3 files changed, 77 insertions(+), 11 deletions(-)
diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt
index ba757470059..2f9b4de1346 100644
--- a/Documentation/git-show-ref.txt
+++ b/Documentation/git-show-ref.txt
@@ -16,6 +16,7 @@ SYNOPSIS
[--] [<ref>...]
'git show-ref' --exclude-existing[=<pattern>]
'git show-ref' --exists <ref>
+'git show-ref' --unresolved <ref>
DESCRIPTION
-----------
@@ -76,6 +77,13 @@ OPTIONS
it does, 2 if it is missing, and 1 in case looking up the reference
failed with an error other than the reference being missing.
+--unresolved::
+
+ Prints out what the reference points to without resolving it. Returns
+ an exit code of 0 if it does, 2 if it is missing, and 1 in case looking
+ up the reference failed with an error other than the reference being
+ missing.
+
--abbrev[=<n>]::
Abbreviate the object name. When using `--hash`, you do
diff --git a/builtin/show-ref.c b/builtin/show-ref.c
index 1c15421e600..58efa078399 100644
--- a/builtin/show-ref.c
+++ b/builtin/show-ref.c
@@ -18,6 +18,7 @@ static const char * const show_ref_usage[] = {
" [--] [<ref>...]"),
N_("git show-ref --exclude-existing[=<pattern>]"),
N_("git show-ref --exists <ref>"),
+ N_("git show-ref --unresolved <ref>"),
NULL
};
@@ -220,11 +221,11 @@ static int cmd_show_ref__patterns(const struct patterns_options *opts,
return 0;
}
-static int cmd_show_ref__exists(const char **refs)
+static int cmd_show_ref__raw(const char **refs, int show)
{
- struct strbuf unused_referent = STRBUF_INIT;
- struct object_id unused_oid;
- unsigned int unused_type;
+ struct strbuf referent = STRBUF_INIT;
+ struct object_id oid;
+ unsigned int type;
int failure_errno = 0;
const char *ref;
int ret = 0;
@@ -236,7 +237,7 @@ static int cmd_show_ref__exists(const char **refs)
die("--exists requires exactly one reference");
if (refs_read_raw_ref(get_main_ref_store(the_repository), ref,
- &unused_oid, &unused_referent, &unused_type,
+ &oid, &referent, &type,
&failure_errno)) {
if (failure_errno == ENOENT || failure_errno == EISDIR) {
error(_("reference does not exist"));
@@ -250,8 +251,16 @@ static int cmd_show_ref__exists(const char **refs)
goto out;
}
+ if (!show)
+ goto out;
+
+ if (type & REF_ISSYMREF)
+ printf("ref: %s\n", referent.buf);
+ else
+ printf("ref: %s\n", oid_to_hex(&oid));
+
out:
- strbuf_release(&unused_referent);
+ strbuf_release(&referent);
return ret;
}
@@ -284,11 +293,12 @@ int cmd_show_ref(int argc, const char **argv, const char *prefix)
struct exclude_existing_options exclude_existing_opts = {0};
struct patterns_options patterns_opts = {0};
struct show_one_options show_one_opts = {0};
- int verify = 0, exists = 0;
+ int verify = 0, exists = 0, unresolved = 0;
const struct option show_ref_options[] = {
OPT_BOOL(0, "tags", &patterns_opts.tags_only, N_("only show tags (can be combined with heads)")),
OPT_BOOL(0, "heads", &patterns_opts.heads_only, N_("only show heads (can be combined with tags)")),
OPT_BOOL(0, "exists", &exists, N_("check for reference existence without resolving")),
+ OPT_BOOL(0, "unresolved", &unresolved, N_("print out unresolved value of reference")),
OPT_BOOL(0, "verify", &verify, N_("stricter reference checking, "
"requires exact ref path")),
OPT_HIDDEN_BOOL('h', NULL, &patterns_opts.show_head,
@@ -314,16 +324,17 @@ int cmd_show_ref(int argc, const char **argv, const char *prefix)
argc = parse_options(argc, argv, prefix, show_ref_options,
show_ref_usage, 0);
- die_for_incompatible_opt3(exclude_existing_opts.enabled, "--exclude-existing",
+ die_for_incompatible_opt4(exclude_existing_opts.enabled, "--exclude-existing",
verify, "--verify",
- exists, "--exists");
+ exists, "--exists",
+ unresolved, "--unresolved");
if (exclude_existing_opts.enabled)
return cmd_show_ref__exclude_existing(&exclude_existing_opts);
else if (verify)
return cmd_show_ref__verify(&show_one_opts, argv);
- else if (exists)
- return cmd_show_ref__exists(argv);
+ else if (exists || unresolved)
+ return cmd_show_ref__raw(argv, unresolved);
else
return cmd_show_ref__patterns(&patterns_opts, &show_one_opts, argv);
}
diff --git a/t/t1403-show-ref.sh b/t/t1403-show-ref.sh
index 33fb7a38fff..11811201738 100755
--- a/t/t1403-show-ref.sh
+++ b/t/t1403-show-ref.sh
@@ -218,6 +218,16 @@ test_expect_success 'show-ref sub-modes are mutually exclusive' '
test_must_fail git show-ref --exclude-existing --exists 2>err &&
grep "exclude-existing" err &&
grep "exists" err &&
+ grep "cannot be used together" err &&
+
+ test_must_fail git show-ref --exclude-existing --unresolved 2>err &&
+ grep "exclude-existing" err &&
+ grep "unresolved" err &&
+ grep "cannot be used together" err &&
+
+ test_must_fail git show-ref --verify --unresolved 2>err &&
+ grep "verify" err &&
+ grep "unresolved" err &&
grep "cannot be used together" err
'
@@ -286,4 +296,41 @@ test_expect_success '--exists with existing special ref' '
git show-ref --exists FETCH_HEAD
'
+test_expect_success '--unresolved with existing reference' '
+ commit_oid=$(git rev-parse refs/heads/$GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME) &&
+ cat >expect <<-EOF &&
+ ref: $commit_oid
+ EOF
+ git show-ref --unresolved refs/heads/$GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME >actual &&
+ test_cmp expect actual
+'
+
+test_expect_success '--unresolved with symbolic ref' '
+ test_when_finished "git symbolic-ref -d SYMBOLIC_REF_A" &&
+ cat >expect <<-EOF &&
+ ref: refs/heads/$GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
+ EOF
+ git symbolic-ref SYMBOLIC_REF_A refs/heads/$GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME &&
+ git show-ref --unresolved SYMBOLIC_REF_A >actual &&
+ test_cmp expect actual
+'
+
+test_expect_success '--unresolved with nonexistent object ID' '
+ oid=$(test_oid 002) &&
+ test-tool ref-store main update-ref msg refs/heads/missing-oid-2 $oid $ZERO_OID REF_SKIP_OID_VERIFICATION &&
+ cat >expect <<-EOF &&
+ ref: $oid
+ EOF
+ git show-ref --unresolved refs/heads/missing-oid-2 >actual &&
+ test_cmp expect actual
+'
+
+test_expect_success '--unresolved with nonexistent reference' '
+ cat >expect <<-EOF &&
+ error: reference does not exist
+ EOF
+ test_expect_code 2 git show-ref --unresolved refs/heads/not-exist 2>err &&
+ test_cmp expect err
+'
+
test_done
base-commit: b387623c12f3f4a376e4d35a610fd3e55d7ea907
--
gitgitgadget
next reply other threads:[~2024-03-04 22:52 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-04 22:51 John Cai via GitGitGadget [this message]
2024-03-04 23:23 ` [PATCH] show-ref: add --unresolved option Junio C Hamano
2024-03-05 20:56 ` John Cai
2024-03-05 21:29 ` Junio C Hamano
2024-03-05 15:30 ` Phillip Wood
2024-03-05 17:01 ` Kristoffer Haugsbakk
2024-03-06 0:33 ` Jeff King
2024-03-06 2:19 ` Junio C Hamano
2024-03-06 0:41 ` Jeff King
2024-03-06 7:31 ` Patrick Steinhardt
2024-03-06 7:51 ` Jeff King
2024-03-06 16:48 ` Junio C Hamano
2024-03-06 9:36 ` Jean-Noël Avila
2024-04-08 17:38 ` [PATCH v2 0/3] show-ref: add --symbolic-name option John Cai via GitGitGadget
2024-04-08 17:38 ` [PATCH v2 1/3] refs: keep track of unresolved reference value in iterator John Cai via GitGitGadget
2024-04-08 23:02 ` Junio C Hamano
2024-04-09 20:29 ` John Cai
2024-04-10 6:52 ` Patrick Steinhardt
2024-04-10 15:26 ` Junio C Hamano
2024-04-11 9:11 ` Patrick Steinhardt
2024-04-08 17:38 ` [PATCH v2 2/3] refs: add referent to each_repo_ref_fn John Cai via GitGitGadget
2024-04-08 17:38 ` [PATCH v2 3/3] show-ref: add --symbolic-name option John Cai via GitGitGadget
2024-04-09 15:25 ` Phillip Wood
2024-04-11 19:57 ` John Cai
2024-04-12 9:37 ` phillip.wood123
2024-04-10 6:53 ` Patrick Steinhardt
2024-04-10 15:27 ` Junio C Hamano
2024-04-12 15:23 ` John Cai
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=pull.1684.git.git.1709592718743.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=git@vger.kernel.org \
--cc=johncai86@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).