From patchwork Sat Oct 12 23:03:23 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bence Ferdinandy X-Patchwork-Id: 13833500 Received: from aib29agh127.zrh1.oracleemaildelivery.com (aib29agh127.zrh1.oracleemaildelivery.com [192.29.178.127]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id D1698149C52 for ; Sat, 12 Oct 2024 23:15:49 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=192.29.178.127 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1728774951; cv=none; b=DWExRx8wh3ARcUDZxllf43pMcZdV9JxoDaum9Vt5ZAPyr+IECsHyJZL7ie1dEicjpJliAxqMK5XpchwrQeu2rs18x60d5S6HRs8tIcgiivH9fjPAIEVmyIr5kF/78j0Kj0Xw5nyRyrCmRrglBTvKq2eDdPpgEVdcU6oSvSR/e1U= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1728774951; c=relaxed/simple; bh=IjaO5ZwaRlqS6jpgYqOUOcatdtzts0zTIkBULUdJy20=; h=From:To:Cc:Subject:Date:Message-id:In-reply-to:References: MIME-version; b=QIcSqEgv/kFEPfcLl04+ufbRinpxYfyxzxfQb7a7dW6Afq7jyd3MaLAulh+8c8pLiWf08ggnXQknYzUbZ8wZo285+wyCvwF9gXyOt8JQAJxfjkBjmCcz7n/DlvNGJVFTwq6Pilp2lu5IXj25Pb6Mpzz9uhipXJGtRPR0KSmi388= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=fail (p=none dis=none) header.from=ferdinandy.com; spf=pass smtp.mailfrom=zrh1.rp.oracleemaildelivery.com; dkim=pass (2048-bit key) header.d=zrh1.rp.oracleemaildelivery.com header.i=@zrh1.rp.oracleemaildelivery.com header.b=PguSqsjN; arc=none smtp.client-ip=192.29.178.127 Authentication-Results: smtp.subspace.kernel.org; dmarc=fail (p=none dis=none) header.from=ferdinandy.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=zrh1.rp.oracleemaildelivery.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=zrh1.rp.oracleemaildelivery.com header.i=@zrh1.rp.oracleemaildelivery.com header.b="PguSqsjN" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; s=prod-zrh-20200406; d=zrh1.rp.oracleemaildelivery.com; h=Date:To:From:Subject:Message-Id:MIME-Version:Sender:List-Unsubscribe:List-Unsubscribe-Post; bh=bIy6emYsXIp48Rwy+1DKliiTQTMc9jsUtNSxp3rqSdc=; b=PguSqsjNJlG9xnkmHrOzKSF1YnJSk2QfsgNsNiuTxeGRAKUDFwWUtJEp3eoEvv1YoDHF7lsrre1Y F1bAYSwPZ86njuF7y97fnWiHI5WqhQXPrV9RmeAbvdC8rZ28am/vLYjKrBaJG9e3DdVRjhUeIRF5 XLo+/CupSU5KVQS03106CS3Eylx9IsVLnZIdOtZp8Gu9znCzSJa/+IKOed7sokmn0Mgbslnv2rFP upsbW52YE0T50OpP3TssWgOMf+ojKGy29ijvBP05kq5Ebu0F+NSQfKUoSbN6RppNgvkifH/Mclkj NxGoXeNNTHr/vaYCojC/AHFghX01RlVq5rDdAA== Received: by omta-ad1-fd3-402-eu-zurich-1.omtaad1.vcndpzrh.oraclevcn.com (Oracle Communications Messaging Server 8.1.0.1.20240911 64bit (built Sep 11 2024)) with ESMTPS id <0SL9008W7NACXY60@omta-ad1-fd3-402-eu-zurich-1.omtaad1.vcndpzrh.oraclevcn.com> for git@vger.kernel.org; Sat, 12 Oct 2024 23:15:48 +0000 (GMT) List-Unsubscribe-Post: List-Unsubscribe=One-Click From: Bence Ferdinandy To: git@vger.kernel.org Cc: phillip.wood@dunelm.org.uk, Taylor Blau , =?utf-8?q?Ren?= =?utf-8?q?=C3=A9_Scharfe?= , Johannes Schindelin , Junio C Hamano , Bence Ferdinandy Subject: [PATCH v7 3/6] remote set-head: better output for --auto Date: Sun, 13 Oct 2024 01:03:23 +0200 Message-id: <20241012230428.3259229-3-bence@ferdinandy.com> In-reply-to: <20241012230428.3259229-1-bence@ferdinandy.com> References: <20241010133022.1733542-1-bence@ferdinandy.com> <20241012230428.3259229-1-bence@ferdinandy.com> Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-version: 1.0 Content-transfer-encoding: 8bit Reporting-Meta: AAGyDThqj/DzwlIBYYc38z5yYxtl9qs7mkGlf7wRrUuWXwwLHFDkH9H0TANtg48M bt7VpTaqMosFK23dNH77fpg6dTuEhPCEG9YyxE0pKpxoxiGe8rzeOVDS4Bbzw167 InEb/5nrR1Ux6dh9jNeMBjHXOMYca9XB3BvdrUn8lrbICws3uwHt40Xr47Yl5BEf TUWZD7yYy/UrIb1giwon+6kvN7GJLy4JhDC9TLzsGr9Cn9lfZaBLXj7XaDIbYL6X iBgqdSSXUPWXwRaguOd0ipygwVSyHr8TMvMavEw9NO58xRnUxZLKCaFiw2lkbwLc +jLi2e9N4bQiYVQdSL0Wemc4WZSApoS+uza0+gaZuByb773HUGvwTL3fyEdUdWRP qppPw5YVIgTdcvQ7mzKSrfec1bSzQOtA0LIyr+qKKvzdBthMl5+Kqx9mNH6ee5DN bReKuX4xLZrNi3NWDcH7PUVrMwEYXso3Pkr7Emi2rbNhGScTF/aP1O8d Currently, set-head --auto will print a message saying "remote/HEAD set to branch", which implies something was changed. Change the output of --auto, so the output actually reflects what was done: a) set a previously unset HEAD, b) change HEAD because remote changed or c) no updates. As a fourth output, if HEAD is changed from a previous value that was not a remote branch, explicitly call attention to this fact. Signed-off-by: Bence Ferdinandy --- Notes: v1-v2: was RFC in https://lore.kernel.org/git/20240910203835.2288291-1-bence@ferdinandy.com/ v3: This patch was originally sent along when I thought set-head was going to be invoked by fetch, but the discussion on the RFC concluded that it should be not. This opened the possibility to make it more explicit. Note: although I feel both things the patch does are really just cosmetic, an argument could be made for breaking it into two, one for the no-op part and one for the --auto print update. Was sent in: https://lore.kernel.org/git/20240915221055.904107-1-bence@ferdinandy.com/ v4: - changes are now handled atomically via the ref update transaction - outputs have changed along the lines of Junio's suggestion - minor refactor to set_head for improved legibility v5: - the minor refactor has been split out into its own patch v6: - fixed uninitialized prev_head - fixed case of unusual previous target - fixed a test that would have been actually broken at this patch (the output was only correct with the later update to fetch) - added 4 tests for the 4 output cases v7: - change commit prefix to be more in line with project standards - fixed tests to also work with the reftable backend - renamed report function, fixed style issue with checking buf len - fixed not releasing an strbuf builtin/remote.c | 35 ++++++++++++++++++++++++++++---- t/t5505-remote.sh | 51 ++++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 81 insertions(+), 5 deletions(-) diff --git a/builtin/remote.c b/builtin/remote.c index 353ffd2c43..2b6948439f 100644 --- a/builtin/remote.c +++ b/builtin/remote.c @@ -1399,10 +1399,35 @@ static int show(int argc, const char **argv, const char *prefix) return result; } +static void report_set_head_auto(const char *remote, const char *head_name, + struct strbuf *buf_prev) { + struct strbuf buf_prefix = STRBUF_INIT; + const char *prev_head = NULL; + + strbuf_addf(&buf_prefix, "refs/remotes/%s/", remote); + skip_prefix(buf_prev->buf, buf_prefix.buf, &prev_head); + + if (prev_head && !strcmp(prev_head, head_name)) + printf("'%s/HEAD' is unchanged and points to '%s'\n", + remote, head_name); + else if (prev_head) + printf("'%s/HEAD' has changed from '%s' and now points to '%s'\n", + remote, prev_head, head_name); + else if (!buf_prev->len) + printf("'%s/HEAD' is now created and points to '%s'\n", + remote, head_name); + else + printf("'%s/HEAD' used to point to '%s' " + "(which is not a remote branch), but now points to '%s'\n", + remote, buf_prev->buf, head_name); + strbuf_release(&buf_prefix); +} + static int set_head(int argc, const char **argv, const char *prefix) { int i, opt_a = 0, opt_d = 0, result = 0; - struct strbuf buf = STRBUF_INIT, buf2 = STRBUF_INIT; + struct strbuf buf = STRBUF_INIT, buf2 = STRBUF_INIT, + buf_prev = STRBUF_INIT; char *head_name = NULL; struct ref_store *refs = get_main_ref_store(the_repository); @@ -1445,15 +1470,17 @@ static int set_head(int argc, const char **argv, const char *prefix) /* make sure it's valid */ if (!refs_ref_exists(refs, buf2.buf)) result |= error(_("Not a valid ref: %s"), buf2.buf); - else if (refs_update_symref(refs, buf.buf, buf2.buf, "remote set-head", NULL)) + else if (refs_update_symref(refs, buf.buf, buf2.buf, "remote set-head", &buf_prev)) result |= error(_("Could not setup %s"), buf.buf); - else if (opt_a) - printf("%s/HEAD set to %s\n", argv[0], head_name); + else if (opt_a) { + report_set_head_auto(argv[0], head_name, &buf_prev); + } free(head_name); } strbuf_release(&buf); strbuf_release(&buf2); + strbuf_release(&buf_prev); return result; } diff --git a/t/t5505-remote.sh b/t/t5505-remote.sh index 532035933f..d99cd1d0aa 100755 --- a/t/t5505-remote.sh +++ b/t/t5505-remote.sh @@ -429,12 +429,51 @@ test_expect_success 'set-head --auto' ' ) ' +test_expect_success 'set-head --auto detects creation' ' + ( + cd test && + git symbolic-ref -d refs/remotes/origin/HEAD && + git remote set-head --auto origin >output && + echo "'\''origin/HEAD'\'' is now created and points to '\''main'\''" >expect && + test_cmp expect output + ) +' + +test_expect_success 'set-head --auto detects no change' ' + ( + cd test && + git remote set-head --auto origin >output && + echo "'\''origin/HEAD'\'' is unchanged and points to '\''main'\''" >expect && + test_cmp expect output + ) +' + +test_expect_success 'set-head --auto detects change' ' + ( + cd test && + git symbolic-ref refs/remotes/origin/HEAD refs/remotes/origin/ahead && + git remote set-head --auto origin >output && + echo "'\''origin/HEAD'\'' has changed from '\''ahead'\'' and now points to '\''main'\''" >expect && + test_cmp expect output + ) +' + +test_expect_success 'set-head --auto detects strange ref' ' + ( + cd test && + git symbolic-ref refs/remotes/origin/HEAD refs/heads/main && + git remote set-head --auto origin >output && + echo "'\''origin/HEAD'\'' used to point to '\''refs/heads/main'\'' (which is not a remote branch), but now points to '\''main'\''" >expect && + test_cmp expect output + ) +' + test_expect_success 'set-head --auto has no problem w/multiple HEADs' ' ( cd test && git fetch two "refs/heads/*:refs/remotes/two/*" && git remote set-head --auto two >output 2>&1 && - echo "two/HEAD set to main" >expect && + echo "'\''two/HEAD'\'' is now created and points to '\''main'\''" >expect && test_cmp expect output ) ' @@ -453,6 +492,16 @@ test_expect_success 'set-head explicit' ' ) ' +test_expect_success 'set-head --auto reports change' ' + ( + cd test && + git remote set-head origin side2 && + git remote set-head --auto origin >output 2>&1 && + echo "'\''origin/HEAD'\'' has changed from '\''side2'\'' and now points to '\''main'\''" >expect && + test_cmp expect output + ) +' + cat >test/expect <