# [PATCH 0/3] Branches are branches and not heads 22 messages from 2024-06-03 to 2024-06-14. Participants: Junio C Hamano, Rubén Justo, Eric Sunshine, Patrick Steinhardt, Elijah Newren. Thread: https://gitlist.dev/t/61579 ## Junio C Hamano, 2024-06-03 20:05 Subject: [PATCH 0/3] Branches are branches and not heads Message-ID: <20240603200539.1473345-1-gitster@pobox.com> URL: https://gitlist.dev/e/20240603200539.1473345-1-gitster%40pobox.com ``` Back when Git started, we used the word "head" to mean the tip of possibly multiple histories, and that is where the name of the hierarchy .git/refs/heads/ came from. But these days we call these entities "branches" in human terms, and "head" is still used to refer to the tip of the history each of these branches represent. When asking "git ls-remote" or "git show-ref" to limit their output to branches (as opposed to showing any ref), we use "--heads" for historical reasons, but give the option a more human friendly name "--branches", and demote "--heads" to the status of a deprecated synonym. This would eventually allow us to remove them at the breaking version boundary. Junio C Hamano (3): refs: call branches branches ls-remote: introduce --branches and deprecate --heads show-ref: introduce --branches and deprecate --heads Documentation/git-ls-remote.txt | 12 +++++++----- Documentation/git-show-ref.txt | 18 ++++++++++-------- builtin/ls-remote.c | 25 ++++++++++++++++++++++--- builtin/show-ref.c | 33 ++++++++++++++++++++++++++------- connect.c | 4 ++-- remote.h | 2 +- t/t1403-show-ref.sh | 22 ++++++++++++++-------- t/t5512-ls-remote.sh | 30 +++++++++++++++++++++++++----- 8 files changed, 107 insertions(+), 39 deletions(-) -- 2.45.2-404-g9eaef5822c ``` ## Junio C Hamano, 2024-06-03 20:05 Subject: [PATCH 1/3] refs: call branches branches Message-ID: <20240603200539.1473345-2-gitster@pobox.com> URL: https://gitlist.dev/e/20240603200539.1473345-2-gitster%40pobox.com In-Reply-To: <20240603200539.1473345-1-gitster@pobox.com> ``` These things in refs/heads/ hierarchy are called "branches" in human parlance. Replace REF_HEADS with REF_BRANCHES to make it clearer. No end-user visible change intended at this step. Signed-off-by: Junio C Hamano --- builtin/ls-remote.c | 6 +++--- connect.c | 4 ++-- remote.h | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/builtin/ls-remote.c b/builtin/ls-remote.c index e8d65ebbdc..9838de69c0 100644 --- a/builtin/ls-remote.c +++ b/builtin/ls-remote.c @@ -9,7 +9,7 @@ #include "wildmatch.h" static const char * const ls_remote_usage[] = { - N_("git ls-remote [--heads] [--tags] [--refs] [--upload-pack=]\n" + N_("git ls-remote [--branches] [--tags] [--refs] [--upload-pack=]\n" " [-q | --quiet] [--exit-code] [--get-url] [--sort=]\n" " [--symref] [ [...]]"), NULL @@ -68,7 +68,7 @@ int cmd_ls_remote(int argc, const char **argv, const char *prefix) N_("path of git-upload-pack on the remote host"), PARSE_OPT_HIDDEN }, OPT_BIT('t', "tags", &flags, N_("limit to tags"), REF_TAGS), - OPT_BIT('h', "heads", &flags, N_("limit to heads"), REF_HEADS), + OPT_BIT('h', "heads", &flags, N_("limit to heads"), REF_BRANCHES), OPT_BIT(0, "refs", &flags, N_("do not show peeled tags"), REF_NORMAL), OPT_BOOL(0, "get-url", &get_url, N_("take url..insteadOf into account")), @@ -100,7 +100,7 @@ int cmd_ls_remote(int argc, const char **argv, const char *prefix) if (flags & REF_TAGS) strvec_push(&transport_options.ref_prefixes, "refs/tags/"); - if (flags & REF_HEADS) + if (flags & REF_BRANCHES) strvec_push(&transport_options.ref_prefixes, "refs/heads/"); remote = remote_get(dest); diff --git a/connect.c b/connect.c index 0d77737a53..cf84e631e9 100644 --- a/connect.c +++ b/connect.c @@ -38,8 +38,8 @@ static int check_ref(const char *name, unsigned int flags) REFNAME_ALLOW_ONELEVEL)) return 0; - /* REF_HEADS means that we want regular branch heads */ - if ((flags & REF_HEADS) && starts_with(name, "heads/")) + /* REF_BRANCHES means that we want regular branch heads */ + if ((flags & REF_BRANCHES) && starts_with(name, "heads/")) return 1; /* REF_TAGS means that we want tags */ diff --git a/remote.h b/remote.h index dfd4837e60..02e330f42c 100644 --- a/remote.h +++ b/remote.h @@ -200,7 +200,7 @@ struct ref { }; #define REF_NORMAL (1u << 0) -#define REF_HEADS (1u << 1) +#define REF_BRANCHES (1u << 1) #define REF_TAGS (1u << 2) struct ref *find_ref_by_name(const struct ref *list, const char *name); -- 2.45.2-404-g9eaef5822c ``` ## Junio C Hamano, 2024-06-03 20:05 Subject: [PATCH 2/3] ls-remote: introduce --branches and deprecate --heads Message-ID: <20240603200539.1473345-3-gitster@pobox.com> URL: https://gitlist.dev/e/20240603200539.1473345-3-gitster%40pobox.com In-Reply-To: <20240603200539.1473345-1-gitster@pobox.com> ``` We call the tips of branches "heads", but this command calls the option to show only branches "--heads", which confuses the branches themselves and the tips of branches. Straighten the terminology by introducing "--branches" option that limits the output to branches, and deprecate "--heads" option used that way. Signed-off-by: Junio C Hamano --- Documentation/git-ls-remote.txt | 12 +++++++----- builtin/ls-remote.c | 21 ++++++++++++++++++++- t/t5512-ls-remote.sh | 30 +++++++++++++++++++++++++----- 3 files changed, 52 insertions(+), 11 deletions(-) diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt index 1c4f696ab5..76c86c3ce4 100644 --- a/Documentation/git-ls-remote.txt +++ b/Documentation/git-ls-remote.txt @@ -9,7 +9,7 @@ git-ls-remote - List references in a remote repository SYNOPSIS -------- [verse] -'git ls-remote' [--heads] [--tags] [--refs] [--upload-pack=] +'git ls-remote' [--branches] [--tags] [--refs] [--upload-pack=] [-q | --quiet] [--exit-code] [--get-url] [--sort=] [--symref] [ [...]] @@ -21,14 +21,16 @@ commit IDs. OPTIONS ------- --h:: ---heads:: +-b:: +--branches:: -t:: --tags:: - Limit to only refs/heads and refs/tags, respectively. + Limit to only local branches and local tags, respectively. These options are _not_ mutually exclusive; when given both, references stored in refs/heads and refs/tags are - displayed. Note that `git ls-remote -h` used without + displayed. Note that `--heads` and `-h` are deprecated + synonyms for `--branches` and `-b` and may be removed in + the future. Also note that `git ls-remote -h` used without anything else on the command line gives help, consistent with other git subcommands. diff --git a/builtin/ls-remote.c b/builtin/ls-remote.c index 9838de69c0..95fbb8b7b5 100644 --- a/builtin/ls-remote.c +++ b/builtin/ls-remote.c @@ -38,6 +38,20 @@ static int tail_match(const char **pattern, const char *path) return 0; } +static int heads_callback(const struct option *opt, const char *arg, int unset) +{ + unsigned *flags = opt->value; + + if (unset) { + warning(_("'--no-heads' is deprecated; use '--no-branches' instead")); + *flags &= ~REF_BRANCHES; + } else { + warning(_("'--heads' is deprecated; use '--branches' instead")); + *flags |= REF_BRANCHES; + } + return 0; +} + int cmd_ls_remote(int argc, const char **argv, const char *prefix) { const char *dest = NULL; @@ -68,7 +82,12 @@ int cmd_ls_remote(int argc, const char **argv, const char *prefix) N_("path of git-upload-pack on the remote host"), PARSE_OPT_HIDDEN }, OPT_BIT('t', "tags", &flags, N_("limit to tags"), REF_TAGS), - OPT_BIT('h', "heads", &flags, N_("limit to heads"), REF_BRANCHES), + OPT_BIT('b', "branches", &flags, N_("limit to branches"), REF_BRANCHES), + OPT_CALLBACK_F('h', "heads", &flags, + NULL, + N_("deprecated synonym for --branches"), + PARSE_OPT_NOARG|PARSE_OPT_HIDDEN, + &heads_callback), OPT_BIT(0, "refs", &flags, N_("do not show peeled tags"), REF_NORMAL), OPT_BOOL(0, "get-url", &get_url, N_("take url..insteadOf into account")), diff --git a/t/t5512-ls-remote.sh b/t/t5512-ls-remote.sh index 5dbe107ce8..b9950ca361 100755 --- a/t/t5512-ls-remote.sh +++ b/t/t5512-ls-remote.sh @@ -47,6 +47,7 @@ test_expect_success setup ' git show-ref -d >refs && sed -e "s/ / /" refs >>expected.all && + grep refs/heads/ expected.all >expected.branches && git remote add self "$(pwd)/.git" && git remote add self2 "." ' @@ -71,6 +72,25 @@ test_expect_success 'ls-remote self' ' test_cmp expected.all actual ' +test_expect_success 'ls-remote --branches self' ' + git ls-remote --branches self >actual && + test_cmp expected.branches actual && + git ls-remote -b self >actual && + test_cmp expected.branches actual +' + +test_expect_success 'ls-remote -h is deprecated' ' + git ls-remote -h self >actual 2>warning && + test_cmp expected.branches actual && + test_grep deprecated warning +' + +test_expect_success 'ls-remote --heads is deprecated' ' + git ls-remote --heads self >actual 2>warning && + test_cmp expected.branches actual && + test_grep deprecated warning +' + test_expect_success 'ls-remote --sort="version:refname" --tags self' ' generate_references \ refs/tags/mark \ @@ -275,7 +295,7 @@ test_expect_success 'ls-remote with filtered symref (refname)' ' test_cmp expect actual ' -test_expect_success 'ls-remote with filtered symref (--heads)' ' +test_expect_success 'ls-remote with filtered symref (--branches)' ' git symbolic-ref refs/heads/foo refs/tags/mark && cat >expect.v2 <<-EOF && ref: refs/tags/mark refs/heads/foo @@ -283,9 +303,9 @@ test_expect_success 'ls-remote with filtered symref (--heads)' ' $rev refs/heads/main EOF grep -v "^ref: refs/tags/" expect.v0 && - git -c protocol.version=0 ls-remote --symref --heads . >actual.v0 && + git -c protocol.version=0 ls-remote --symref --branches . >actual.v0 && test_cmp expect.v0 actual.v0 && - git -c protocol.version=2 ls-remote --symref --heads . >actual.v2 && + git -c protocol.version=2 ls-remote --symref --branches . >actual.v2 && test_cmp expect.v2 actual.v2 ' @@ -335,9 +355,9 @@ test_expect_success 'ls-remote patterns work with all protocol versions' ' test_expect_success 'ls-remote prefixes work with all protocol versions' ' git for-each-ref --format="%(objectname) %(refname)" \ refs/heads/ refs/tags/ >expect && - git -c protocol.version=0 ls-remote --heads --tags . >actual.v0 && + git -c protocol.version=0 ls-remote --branches --tags . >actual.v0 && test_cmp expect actual.v0 && - git -c protocol.version=2 ls-remote --heads --tags . >actual.v2 && + git -c protocol.version=2 ls-remote --branches --tags . >actual.v2 && test_cmp expect actual.v2 ' -- 2.45.2-404-g9eaef5822c ``` ## Junio C Hamano, 2024-06-03 20:05 Subject: [PATCH 3/3] show-ref: introduce --branches and deprecate --heads Message-ID: <20240603200539.1473345-4-gitster@pobox.com> URL: https://gitlist.dev/e/20240603200539.1473345-4-gitster%40pobox.com In-Reply-To: <20240603200539.1473345-1-gitster@pobox.com> ``` We call the tips of branches "heads", but this command calls the option to show only branches "--heads", which confuses the branches themselves and the tips of branches. Straighten the terminology by introducing "--branches" option that limits the output to branches, and deprecate "--heads" option used that way. Signed-off-by: Junio C Hamano --- Documentation/git-show-ref.txt | 18 ++++++++++-------- builtin/show-ref.c | 33 ++++++++++++++++++++++++++------- t/t1403-show-ref.sh | 22 ++++++++++++++-------- 3 files changed, 50 insertions(+), 23 deletions(-) diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt index ba75747005..616d919655 100644 --- a/Documentation/git-show-ref.txt +++ b/Documentation/git-show-ref.txt @@ -9,8 +9,8 @@ SYNOPSIS -------- [verse] 'git show-ref' [--head] [-d | --dereference] - [-s | --hash[=]] [--abbrev[=]] [--tags] - [--heads] [--] [...] + [-s | --hash[=]] [--abbrev[=]] [--branches] [--tags] + [--] [...] 'git show-ref' --verify [-q | --quiet] [-d | --dereference] [-s | --hash[=]] [--abbrev[=]] [--] [...] @@ -45,12 +45,14 @@ OPTIONS Show the HEAD reference, even if it would normally be filtered out. ---heads:: +--branches:: --tags:: - Limit to "refs/heads" and "refs/tags", respectively. These options + Limit to local branches and local tags, respectively. These options are not mutually exclusive; when given both, references stored in - "refs/heads" and "refs/tags" are displayed. + "refs/heads" and "refs/tags" are displayed. Note that `--heads` + is a deprecated synonym for `--branches` and may be removed + in the future. -d:: --dereference:: @@ -139,7 +141,7 @@ When using `--hash` (and not `--dereference`), the output is in the format: For example, ----------------------------------------------------------------------------- -$ git show-ref --heads --hash +$ git show-ref --branches --hash 2e3ba0114a1f52b47df29743d6915d056be13278 185008ae97960c8d551adcd9e23565194651b5d1 03adf42c988195b50e1a1935ba5fcbc39b2b029b @@ -183,8 +185,8 @@ to check whether a particular branch exists or not (notice how we don't actually want to show any results, and we want to use the full refname for it in order to not trigger the problem with ambiguous partial matches). -To show only tags, or only proper branch heads, use `--tags` and/or `--heads` -respectively (using both means that it shows tags and heads, but not other +To show only tags, or only proper branch heads, use `--tags` and/or `--branches` +respectively (using both means that it shows tags and branches, but not other random references under the refs/ subdirectory). To do automatic tag object dereferencing, use the `-d` or `--dereference` diff --git a/builtin/show-ref.c b/builtin/show-ref.c index 1c15421e60..6b69daeb66 100644 --- a/builtin/show-ref.c +++ b/builtin/show-ref.c @@ -11,8 +11,8 @@ static const char * const show_ref_usage[] = { N_("git show-ref [--head] [-d | --dereference]\n" - " [-s | --hash[=]] [--abbrev[=]] [--tags]\n" - " [--heads] [--] [...]"), + " [-s | --hash[=]] [--abbrev[=]] [--branches] [--tags]\n" + " [--] [...]"), N_("git show-ref --verify [-q | --quiet] [-d | --dereference]\n" " [-s | --hash[=]] [--abbrev[=]]\n" " [--] [...]"), @@ -188,7 +188,7 @@ static int cmd_show_ref__verify(const struct show_one_options *show_one_opts, struct patterns_options { int show_head; - int heads_only; + int branches_only; int tags_only; }; @@ -206,8 +206,8 @@ static int cmd_show_ref__patterns(const struct patterns_options *opts, if (opts->show_head) head_ref(show_ref, &show_ref_data); - if (opts->heads_only || opts->tags_only) { - if (opts->heads_only) + if (opts->branches_only || opts->tags_only) { + if (opts->branches_only) for_each_fullref_in("refs/heads/", show_ref, &show_ref_data); if (opts->tags_only) for_each_fullref_in("refs/tags/", show_ref, &show_ref_data); @@ -279,6 +279,20 @@ static int exclude_existing_callback(const struct option *opt, const char *arg, return 0; } +static int heads_callback(const struct option *opt, const char *arg, int unset) +{ + int *branches_only = opt->value; + + if (unset) { + warning(_("'--no-heads' is deprecated; use '--no-branches' instead")); + *branches_only = 0; + } else { + warning(_("'--heads' is deprecated; use '--branches' instead")); + *branches_only = 1; + } + return 0; +} + int cmd_show_ref(int argc, const char **argv, const char *prefix) { struct exclude_existing_options exclude_existing_opts = {0}; @@ -286,8 +300,13 @@ int cmd_show_ref(int argc, const char **argv, const char *prefix) struct show_one_options show_one_opts = {0}; int verify = 0, exists = 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, "tags", &patterns_opts.tags_only, N_("only show tags (can be combined with branches)")), + OPT_BOOL(0, "branches", &patterns_opts.branches_only, N_("only show branches (can be combined with tags)")), + OPT_CALLBACK_F(0, "heads", &patterns_opts.branches_only, + NULL, + N_("deprecated synonym for --branches)"), + PARSE_OPT_NOARG|PARSE_OPT_HIDDEN, + &heads_callback), OPT_BOOL(0, "exists", &exists, N_("check for reference existence without resolving")), OPT_BOOL(0, "verify", &verify, N_("stricter reference checking, " "requires exact ref path")), diff --git a/t/t1403-show-ref.sh b/t/t1403-show-ref.sh index 33fb7a38ff..b72ed70435 100755 --- a/t/t1403-show-ref.sh +++ b/t/t1403-show-ref.sh @@ -121,13 +121,13 @@ test_expect_success 'show-ref -d' ' ' -test_expect_success 'show-ref --heads, --tags, --head, pattern' ' +test_expect_success 'show-ref --branches, --tags, --head, pattern' ' for branch in B main side do echo $(git rev-parse refs/heads/$branch) refs/heads/$branch || return 1 - done >expect.heads && - git show-ref --heads >actual && - test_cmp expect.heads actual && + done >expect.branches && + git show-ref --branches >actual && + test_cmp expect.branches actual && for tag in A B C do @@ -136,15 +136,15 @@ test_expect_success 'show-ref --heads, --tags, --head, pattern' ' git show-ref --tags >actual && test_cmp expect.tags actual && - cat expect.heads expect.tags >expect && - git show-ref --heads --tags >actual && + cat expect.branches expect.tags >expect && + git show-ref --branches --tags >actual && test_cmp expect actual && { echo $(git rev-parse HEAD) HEAD && - cat expect.heads expect.tags + cat expect.branches expect.tags } >expect && - git show-ref --heads --tags --head >actual && + git show-ref --branches --tags --head >actual && test_cmp expect actual && { @@ -165,6 +165,12 @@ test_expect_success 'show-ref --heads, --tags, --head, pattern' ' test_cmp expect actual ' +test_expect_success 'show-ref --heads is deprecated' ' + git show-ref --heads >actual 2>warning && + test_grep deprecated warning && + test_cmp expect.branches actual +' + test_expect_success 'show-ref --verify HEAD' ' echo $(git rev-parse HEAD) HEAD >expect && git show-ref --verify HEAD >actual && -- 2.45.2-404-g9eaef5822c ``` ## Rubén Justo, 2024-06-03 21:30 Subject: Re: [PATCH 2/3] ls-remote: introduce --branches and deprecate --heads Message-ID: URL: https://gitlist.dev/e/aa9ff9a4-d504-45c7-8b4e-9744bf0b93aa%40gmail.com In-Reply-To: <20240603200539.1473345-3-gitster@pobox.com> ``` On Mon, Jun 03, 2024 at 01:05:38PM -0700, Junio C Hamano wrote: > We call the tips of branches "heads", but this command calls the > option to show only branches "--heads", which confuses the branches > themselves and the tips of branches. > > Straighten the terminology by introducing "--branches" option that > limits the output to branches, and deprecate "--heads" option used > that way. > > Signed-off-by: Junio C Hamano > --- > Documentation/git-ls-remote.txt | 12 +++++++----- > builtin/ls-remote.c | 21 ++++++++++++++++++++- > t/t5512-ls-remote.sh | 30 +++++++++++++++++++++++++----- > 3 files changed, 52 insertions(+), 11 deletions(-) > > diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt > index 1c4f696ab5..76c86c3ce4 100644 > --- a/Documentation/git-ls-remote.txt > +++ b/Documentation/git-ls-remote.txt > @@ -9,7 +9,7 @@ git-ls-remote - List references in a remote repository > SYNOPSIS > -------- > [verse] > -'git ls-remote' [--heads] [--tags] [--refs] [--upload-pack=] > +'git ls-remote' [--branches] [--tags] [--refs] [--upload-pack=] > [-q | --quiet] [--exit-code] [--get-url] [--sort=] > [--symref] [ [...]] > > @@ -21,14 +21,16 @@ commit IDs. > > OPTIONS > ------- > --h:: > ---heads:: > +-b:: Perhaps we can avoid this 'single-letter' option, due to we're no giving the same abbreviation for '--branches' in other places. > +--branches:: > -t:: > --tags:: > - Limit to only refs/heads and refs/tags, respectively. > + Limit to only local branches and local tags, respectively. > These options are _not_ mutually exclusive; when given > both, references stored in refs/heads and refs/tags are > - displayed. Note that `git ls-remote -h` used without > + displayed. Note that `--heads` and `-h` are deprecated > + synonyms for `--branches` and `-b` and may be removed in > + the future. Also note that `git ls-remote -h` used without > anything else on the command line gives help, consistent > with other git subcommands. > > diff --git a/builtin/ls-remote.c b/builtin/ls-remote.c > index 9838de69c0..95fbb8b7b5 100644 > --- a/builtin/ls-remote.c > +++ b/builtin/ls-remote.c > @@ -38,6 +38,20 @@ static int tail_match(const char **pattern, const char *path) > return 0; > } > > +static int heads_callback(const struct option *opt, const char *arg, int unset) > +{ > + unsigned *flags = opt->value; > + > + if (unset) { > + warning(_("'--no-heads' is deprecated; use '--no-branches' instead")); I wonder if this would be better: warning(_("'%s' is deprecated; use '%s' instead"), '--no-heads', '--no-branches'); > + *flags &= ~REF_BRANCHES; > + } else { > + warning(_("'--heads' is deprecated; use '--branches' instead")); > + *flags |= REF_BRANCHES; > + } > + return 0; > +} > + > int cmd_ls_remote(int argc, const char **argv, const char *prefix) > { > const char *dest = NULL; > @@ -68,7 +82,12 @@ int cmd_ls_remote(int argc, const char **argv, const char *prefix) > N_("path of git-upload-pack on the remote host"), > PARSE_OPT_HIDDEN }, > OPT_BIT('t', "tags", &flags, N_("limit to tags"), REF_TAGS), > - OPT_BIT('h', "heads", &flags, N_("limit to heads"), REF_BRANCHES), > + OPT_BIT('b', "branches", &flags, N_("limit to branches"), REF_BRANCHES), > + OPT_CALLBACK_F('h', "heads", &flags, > + NULL, > + N_("deprecated synonym for --branches"), > + PARSE_OPT_NOARG|PARSE_OPT_HIDDEN, > + &heads_callback), > OPT_BIT(0, "refs", &flags, N_("do not show peeled tags"), REF_NORMAL), > OPT_BOOL(0, "get-url", &get_url, > N_("take url..insteadOf into account")), > diff --git a/t/t5512-ls-remote.sh b/t/t5512-ls-remote.sh > index 5dbe107ce8..b9950ca361 100755 > --- a/t/t5512-ls-remote.sh > +++ b/t/t5512-ls-remote.sh > @@ -47,6 +47,7 @@ test_expect_success setup ' > git show-ref -d >refs && > sed -e "s/ / /" refs >>expected.all && > > + grep refs/heads/ expected.all >expected.branches && > git remote add self "$(pwd)/.git" && > git remote add self2 "." > ' > @@ -71,6 +72,25 @@ test_expect_success 'ls-remote self' ' > test_cmp expected.all actual > ' > > +test_expect_success 'ls-remote --branches self' ' > + git ls-remote --branches self >actual && > + test_cmp expected.branches actual && > + git ls-remote -b self >actual && > + test_cmp expected.branches actual > +' > + > +test_expect_success 'ls-remote -h is deprecated' ' > + git ls-remote -h self >actual 2>warning && > + test_cmp expected.branches actual && > + test_grep deprecated warning > +' > + > +test_expect_success 'ls-remote --heads is deprecated' ' > + git ls-remote --heads self >actual 2>warning && > + test_cmp expected.branches actual && > + test_grep deprecated warning > +' > + > test_expect_success 'ls-remote --sort="version:refname" --tags self' ' > generate_references \ > refs/tags/mark \ > @@ -275,7 +295,7 @@ test_expect_success 'ls-remote with filtered symref (refname)' ' > test_cmp expect actual > ' > > -test_expect_success 'ls-remote with filtered symref (--heads)' ' > +test_expect_success 'ls-remote with filtered symref (--branches)' ' > git symbolic-ref refs/heads/foo refs/tags/mark && > cat >expect.v2 <<-EOF && > ref: refs/tags/mark refs/heads/foo > @@ -283,9 +303,9 @@ test_expect_success 'ls-remote with filtered symref (--heads)' ' > $rev refs/heads/main > EOF > grep -v "^ref: refs/tags/" expect.v0 && > - git -c protocol.version=0 ls-remote --symref --heads . >actual.v0 && > + git -c protocol.version=0 ls-remote --symref --branches . >actual.v0 && > test_cmp expect.v0 actual.v0 && > - git -c protocol.version=2 ls-remote --symref --heads . >actual.v2 && > + git -c protocol.version=2 ls-remote --symref --branches . >actual.v2 && > test_cmp expect.v2 actual.v2 > ' > > @@ -335,9 +355,9 @@ test_expect_success 'ls-remote patterns work with all protocol versions' ' > test_expect_success 'ls-remote prefixes work with all protocol versions' ' > git for-each-ref --format="%(objectname) %(refname)" \ > refs/heads/ refs/tags/ >expect && > - git -c protocol.version=0 ls-remote --heads --tags . >actual.v0 && > + git -c protocol.version=0 ls-remote --branches --tags . >actual.v0 && > test_cmp expect actual.v0 && > - git -c protocol.version=2 ls-remote --heads --tags . >actual.v2 && > + git -c protocol.version=2 ls-remote --branches --tags . >actual.v2 && > test_cmp expect actual.v2 > ' > > -- > 2.45.2-404-g9eaef5822c > ``` ## Rubén Justo, 2024-06-03 21:32 Subject: Re: [PATCH 0/3] Branches are branches and not heads Message-ID: <511c8bf6-9dea-4bac-9f9b-fd400bbad7b3@gmail.com> URL: https://gitlist.dev/e/511c8bf6-9dea-4bac-9f9b-fd400bbad7b3%40gmail.com In-Reply-To: <20240603200539.1473345-1-gitster@pobox.com> ``` On Mon, Jun 03, 2024 at 01:05:36PM -0700, Junio C Hamano wrote: > Back when Git started, we used the word "head" to mean the tip of > possibly multiple histories, and that is where the name of the > hierarchy .git/refs/heads/ came from. But these days we call these > entities "branches" in human terms, and "head" is still used to refer > to the tip of the history each of these branches represent. > > When asking "git ls-remote" or "git show-ref" to limit their output to > branches (as opposed to showing any ref), we use "--heads" for > historical reasons, but give the option a more human friendly name > "--branches", and demote "--heads" to the status of a deprecated > synonym. This would eventually allow us to remove them at the > breaking version boundary. All of this sounds like a very sensible step, to me. I've left a couple of nits; none important. Thanks. > > Junio C Hamano (3): > refs: call branches branches > ls-remote: introduce --branches and deprecate --heads > show-ref: introduce --branches and deprecate --heads > > Documentation/git-ls-remote.txt | 12 +++++++----- > Documentation/git-show-ref.txt | 18 ++++++++++-------- > builtin/ls-remote.c | 25 ++++++++++++++++++++++--- > builtin/show-ref.c | 33 ++++++++++++++++++++++++++------- > connect.c | 4 ++-- > remote.h | 2 +- > t/t1403-show-ref.sh | 22 ++++++++++++++-------- > t/t5512-ls-remote.sh | 30 +++++++++++++++++++++++++----- > 8 files changed, 107 insertions(+), 39 deletions(-) > > -- > 2.45.2-404-g9eaef5822c > ``` ## Eric Sunshine, 2024-06-03 21:32 Subject: Re: [PATCH 1/3] refs: call branches branches Message-ID: URL: https://gitlist.dev/e/CAPig%2BcQ-kacp_4UoPPOOaZ6k6fa0cDNCYowdc1S7qJ1XteaMuQ%40mail.gmail.com In-Reply-To: <20240603200539.1473345-2-gitster@pobox.com> ``` On Mon, Jun 3, 2024 at 4:05 PM Junio C Hamano wrote: > These things in refs/heads/ hierarchy are called "branches" in human > parlance. Replace REF_HEADS with REF_BRANCHES to make it clearer. > > No end-user visible change intended at this step. > > Signed-off-by: Junio C Hamano > --- > diff --git a/builtin/ls-remote.c b/builtin/ls-remote.c > @@ -9,7 +9,7 @@ > static const char * const ls_remote_usage[] = { > - N_("git ls-remote [--heads] [--tags] [--refs] [--upload-pack=]\n" > + N_("git ls-remote [--branches] [--tags] [--refs] [--upload-pack=]\n" > " [-q | --quiet] [--exit-code] [--get-url] [--sort=]\n" > " [--symref] [ [...]]"), > NULL This change belongs in patch [2/3], doesn't it, not [1/3]? ``` ## Eric Sunshine, 2024-06-03 21:42 Subject: Re: [PATCH 2/3] ls-remote: introduce --branches and deprecate --heads Message-ID: URL: https://gitlist.dev/e/CAPig%2BcQGtgaz3czkg%2BFaj%2BCL_-TD0BdbEc1hg6eJuq_yZmvg9w%40mail.gmail.com In-Reply-To: ``` On Mon, Jun 3, 2024 at 5:30 PM Rubén Justo wrote: > On Mon, Jun 03, 2024 at 01:05:38PM -0700, Junio C Hamano wrote: > > + if (unset) { > > + warning(_("'--no-heads' is deprecated; use '--no-branches' instead")); > > I wonder if this would be better: > > warning(_("'%s' is deprecated; use '%s' instead"), '--no-heads', '--no-branches'); Unless there is a concrete plan to free up --heads to mean something else in the future, I wonder why we need to warn about this at all, especially since retaining the deprecated --heads alias in perpetuity is effectively zero-cost for the Git maintainers, whereas adding this warning potentially punishes users by making them do extra work for no obvious reason. ``` ## Junio C Hamano, 2024-06-03 21:48 Subject: Re: [PATCH 2/3] ls-remote: introduce --branches and deprecate --heads Message-ID: URL: https://gitlist.dev/e/xmqqzfs11yv4.fsf%40gitster.g In-Reply-To: ``` Eric Sunshine writes: > Unless there is a concrete plan to free up --heads to mean something > else in the future, I wonder why we need to warn about this at all, There is no plan to repurpose "--heads", but this is primarily to make sure "-h" cannot mean anything but "please give me a short help". ``` ## Patrick Steinhardt, 2024-06-04 07:56 Subject: Re: [PATCH 0/3] Branches are branches and not heads Message-ID: URL: https://gitlist.dev/e/Zl7Ina9Uldi1jyMd%40framework In-Reply-To: <511c8bf6-9dea-4bac-9f9b-fd400bbad7b3@gmail.com> ``` On Mon, Jun 03, 2024 at 11:32:18PM +0200, Rubén Justo wrote: > On Mon, Jun 03, 2024 at 01:05:36PM -0700, Junio C Hamano wrote: > > Back when Git started, we used the word "head" to mean the tip of > > possibly multiple histories, and that is where the name of the > > hierarchy .git/refs/heads/ came from. But these days we call these > > entities "branches" in human terms, and "head" is still used to refer > > to the tip of the history each of these branches represent. > > > > When asking "git ls-remote" or "git show-ref" to limit their output to > > branches (as opposed to showing any ref), we use "--heads" for > > historical reasons, but give the option a more human friendly name > > "--branches", and demote "--heads" to the status of a deprecated > > synonym. This would eventually allow us to remove them at the > > breaking version boundary. > > All of this sounds like a very sensible step, to me. > > I've left a couple of nits; none important. Agreed, I like the direction of this patch series very much. I've got nothing to add on top of what has already been said. Thanks! Patrick ``` ## Junio C Hamano, 2024-06-04 22:01 Subject: [PATCH v2 0/3] Branches are branches and not heads Message-ID: <20240604220145.3260714-1-gitster@pobox.com> URL: https://gitlist.dev/e/20240604220145.3260714-1-gitster%40pobox.com In-Reply-To: <20240603200539.1473345-1-gitster@pobox.com> ``` tl;dr for those who did read v1: v2 does not warn when deprecated variants are used. ---------------------- Back when Git started, we used the word "head" to mean the tip of possibly multiple histories, and that is where the name of the hierarchy .git/refs/heads/ came from. But these days we call these entities "branches" in human terms, and "head" is still used to refer to the tip of the history each of these branches represent. When asking "git ls-remote" or "git show-ref" to limit their output to branches (as opposed to showing any ref), we use "--heads" for historical reasons, but give the option a more human friendly name "--branches", and demote "--heads" to the status of a deprecated synonym. We do not plan to remove "--heads" or "-h" yet, but we may want to do so at the Git 3.0 boundary, in which case we will need to start advertising upcoming removal with an extra warning when they are used. But let's not start annoying users for now. Junio C Hamano (3): refs: call branches branches ls-remote: introduce --branches and deprecate --heads show-ref: introduce --branches and deprecate --heads Documentation/git-ls-remote.txt | 12 +++++++----- Documentation/git-show-ref.txt | 18 ++++++++++-------- builtin/ls-remote.c | 9 ++++++--- builtin/show-ref.c | 16 +++++++++------- connect.c | 4 ++-- remote.h | 2 +- t/t1403-show-ref.sh | 24 ++++++++++++++++-------- t/t5512-ls-remote.sh | 32 +++++++++++++++++++++++++++----- 8 files changed, 78 insertions(+), 39 deletions(-) Range-diff against v1: 1: 2c551ed37b = 1: 2c551ed37b refs: call branches branches 2: f88fe89ff7 ! 2: 5549e98042 ls-remote: introduce --branches and deprecate --heads @@ Commit message limits the output to branches, and deprecate "--heads" option used that way. + We do not plan to remove "--heads" or "-h" yet; we may want to do so + at Git 3.0, in which case, we may need to start advertising upcoming + removal with an extra warning when they are used. + Signed-off-by: Junio C Hamano ## Documentation/git-ls-remote.txt ## @@ builtin/ls-remote.c " [-q | --quiet] [--exit-code] [--get-url] [--sort=]\n" " [--symref] [ [...]]"), NULL -@@ builtin/ls-remote.c: static int tail_match(const char **pattern, const char *path) - return 0; - } - -+static int heads_callback(const struct option *opt, const char *arg, int unset) -+{ -+ unsigned *flags = opt->value; -+ -+ if (unset) { -+ warning(_("'--no-heads' is deprecated; use '--no-branches' instead")); -+ *flags &= ~REF_BRANCHES; -+ } else { -+ warning(_("'--heads' is deprecated; use '--branches' instead")); -+ *flags |= REF_BRANCHES; -+ } -+ return 0; -+} -+ - int cmd_ls_remote(int argc, const char **argv, const char *prefix) - { - const char *dest = NULL; @@ builtin/ls-remote.c: int cmd_ls_remote(int argc, const char **argv, const char *prefix) N_("path of git-upload-pack on the remote host"), PARSE_OPT_HIDDEN }, OPT_BIT('t', "tags", &flags, N_("limit to tags"), REF_TAGS), - OPT_BIT('h', "heads", &flags, N_("limit to heads"), REF_BRANCHES), + OPT_BIT('b', "branches", &flags, N_("limit to branches"), REF_BRANCHES), -+ OPT_CALLBACK_F('h', "heads", &flags, -+ NULL, -+ N_("deprecated synonym for --branches"), -+ PARSE_OPT_NOARG|PARSE_OPT_HIDDEN, -+ &heads_callback), ++ OPT_BIT_F('h', "heads", &flags, ++ N_("deprecated synonym for --branches"), REF_BRANCHES, ++ PARSE_OPT_HIDDEN), OPT_BIT(0, "refs", &flags, N_("do not show peeled tags"), REF_NORMAL), OPT_BOOL(0, "get-url", &get_url, N_("take url..insteadOf into account")), @@ t/t5512-ls-remote.sh: test_expect_success 'ls-remote self' ' + test_cmp expected.branches actual +' + -+test_expect_success 'ls-remote -h is deprecated' ' ++test_expect_success 'ls-remote -h is deprecated w/o warning' ' + git ls-remote -h self >actual 2>warning && + test_cmp expected.branches actual && -+ test_grep deprecated warning ++ test_grep ! deprecated warning +' + -+test_expect_success 'ls-remote --heads is deprecated' ' ++test_expect_success 'ls-remote --heads is deprecated and hidden w/o warning' ' ++ test_expect_code 129 git ls-remote -h >short-help && ++ test_grep ! -e --head short-help && + git ls-remote --heads self >actual 2>warning && + test_cmp expected.branches actual && -+ test_grep deprecated warning ++ test_grep ! deprecated warning +' + test_expect_success 'ls-remote --sort="version:refname" --tags self' ' 3: 295554edfc ! 3: 9022743a32 show-ref: introduce --branches and deprecate --heads @@ Commit message limits the output to branches, and deprecate "--heads" option used that way. + We do not plan to remove "--heads" or "-h" yet; we may want to do so + at Git 3.0, in which case, we may need to start advertising upcoming + removal with an extra warning when they are used. + Signed-off-by: Junio C Hamano ## Documentation/git-show-ref.txt ## @@ builtin/show-ref.c: static int cmd_show_ref__patterns(const struct patterns_opti for_each_fullref_in("refs/heads/", show_ref, &show_ref_data); if (opts->tags_only) for_each_fullref_in("refs/tags/", show_ref, &show_ref_data); -@@ builtin/show-ref.c: static int exclude_existing_callback(const struct option *opt, const char *arg, - return 0; - } - -+static int heads_callback(const struct option *opt, const char *arg, int unset) -+{ -+ int *branches_only = opt->value; -+ -+ if (unset) { -+ warning(_("'--no-heads' is deprecated; use '--no-branches' instead")); -+ *branches_only = 0; -+ } else { -+ warning(_("'--heads' is deprecated; use '--branches' instead")); -+ *branches_only = 1; -+ } -+ return 0; -+} -+ - int cmd_show_ref(int argc, const char **argv, const char *prefix) - { - struct exclude_existing_options exclude_existing_opts = {0}; @@ builtin/show-ref.c: int cmd_show_ref(int argc, const char **argv, const char *prefix) struct show_one_options show_one_opts = {0}; int verify = 0, exists = 0; @@ builtin/show-ref.c: int cmd_show_ref(int argc, const char **argv, const char *pr - OPT_BOOL(0, "heads", &patterns_opts.heads_only, N_("only show heads (can be combined with tags)")), + OPT_BOOL(0, "tags", &patterns_opts.tags_only, N_("only show tags (can be combined with branches)")), + OPT_BOOL(0, "branches", &patterns_opts.branches_only, N_("only show branches (can be combined with tags)")), -+ OPT_CALLBACK_F(0, "heads", &patterns_opts.branches_only, -+ NULL, -+ N_("deprecated synonym for --branches)"), -+ PARSE_OPT_NOARG|PARSE_OPT_HIDDEN, -+ &heads_callback), ++ OPT_HIDDEN_BOOL(0, "heads", &patterns_opts.branches_only, ++ N_("deprecated synonym for --branches")), OPT_BOOL(0, "exists", &exists, N_("check for reference existence without resolving")), OPT_BOOL(0, "verify", &verify, N_("stricter reference checking, " "requires exact ref path")), @@ t/t1403-show-ref.sh: test_expect_success 'show-ref --heads, --tags, --head, patt test_cmp expect actual ' -+test_expect_success 'show-ref --heads is deprecated' ' ++test_expect_success 'show-ref --heads is deprecated and hidden' ' ++ test_expect_code 129 git show-ref -h >short-help && ++ test_grep ! -e --heads short-help && + git show-ref --heads >actual 2>warning && -+ test_grep deprecated warning && ++ test_grep ! deprecated warning && + test_cmp expect.branches actual +' + -- 2.45.2-409-g7b0defb391 ``` ## Junio C Hamano, 2024-06-04 22:01 Subject: [PATCH v2 1/3] refs: call branches branches Message-ID: <20240604220145.3260714-2-gitster@pobox.com> URL: https://gitlist.dev/e/20240604220145.3260714-2-gitster%40pobox.com In-Reply-To: <20240604220145.3260714-1-gitster@pobox.com> ``` These things in refs/heads/ hierarchy are called "branches" in human parlance. Replace REF_HEADS with REF_BRANCHES to make it clearer. No end-user visible change intended at this step. Signed-off-by: Junio C Hamano --- builtin/ls-remote.c | 4 ++-- connect.c | 4 ++-- remote.h | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/builtin/ls-remote.c b/builtin/ls-remote.c index e8d65ebbdc..65fb22a8a2 100644 --- a/builtin/ls-remote.c +++ b/builtin/ls-remote.c @@ -68,7 +68,7 @@ int cmd_ls_remote(int argc, const char **argv, const char *prefix) N_("path of git-upload-pack on the remote host"), PARSE_OPT_HIDDEN }, OPT_BIT('t', "tags", &flags, N_("limit to tags"), REF_TAGS), - OPT_BIT('h', "heads", &flags, N_("limit to heads"), REF_HEADS), + OPT_BIT('h', "heads", &flags, N_("limit to heads"), REF_BRANCHES), OPT_BIT(0, "refs", &flags, N_("do not show peeled tags"), REF_NORMAL), OPT_BOOL(0, "get-url", &get_url, N_("take url..insteadOf into account")), @@ -100,7 +100,7 @@ int cmd_ls_remote(int argc, const char **argv, const char *prefix) if (flags & REF_TAGS) strvec_push(&transport_options.ref_prefixes, "refs/tags/"); - if (flags & REF_HEADS) + if (flags & REF_BRANCHES) strvec_push(&transport_options.ref_prefixes, "refs/heads/"); remote = remote_get(dest); diff --git a/connect.c b/connect.c index 0d77737a53..cf84e631e9 100644 --- a/connect.c +++ b/connect.c @@ -38,8 +38,8 @@ static int check_ref(const char *name, unsigned int flags) REFNAME_ALLOW_ONELEVEL)) return 0; - /* REF_HEADS means that we want regular branch heads */ - if ((flags & REF_HEADS) && starts_with(name, "heads/")) + /* REF_BRANCHES means that we want regular branch heads */ + if ((flags & REF_BRANCHES) && starts_with(name, "heads/")) return 1; /* REF_TAGS means that we want tags */ diff --git a/remote.h b/remote.h index dfd4837e60..02e330f42c 100644 --- a/remote.h +++ b/remote.h @@ -200,7 +200,7 @@ struct ref { }; #define REF_NORMAL (1u << 0) -#define REF_HEADS (1u << 1) +#define REF_BRANCHES (1u << 1) #define REF_TAGS (1u << 2) struct ref *find_ref_by_name(const struct ref *list, const char *name); -- 2.45.2-409-g7b0defb391 ``` ## Junio C Hamano, 2024-06-04 22:01 Subject: [PATCH v2 2/3] ls-remote: introduce --branches and deprecate --heads Message-ID: <20240604220145.3260714-3-gitster@pobox.com> URL: https://gitlist.dev/e/20240604220145.3260714-3-gitster%40pobox.com In-Reply-To: <20240604220145.3260714-1-gitster@pobox.com> ``` We call the tips of branches "heads", but this command calls the option to show only branches "--heads", which confuses the branches themselves and the tips of branches. Straighten the terminology by introducing "--branches" option that limits the output to branches, and deprecate "--heads" option used that way. We do not plan to remove "--heads" or "-h" yet; we may want to do so at Git 3.0, in which case, we may need to start advertising upcoming removal with an extra warning when they are used. Signed-off-by: Junio C Hamano --- Documentation/git-ls-remote.txt | 12 +++++++----- builtin/ls-remote.c | 7 +++++-- t/t5512-ls-remote.sh | 32 +++++++++++++++++++++++++++----- 3 files changed, 39 insertions(+), 12 deletions(-) diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt index 1c4f696ab5..76c86c3ce4 100644 --- a/Documentation/git-ls-remote.txt +++ b/Documentation/git-ls-remote.txt @@ -9,7 +9,7 @@ git-ls-remote - List references in a remote repository SYNOPSIS -------- [verse] -'git ls-remote' [--heads] [--tags] [--refs] [--upload-pack=] +'git ls-remote' [--branches] [--tags] [--refs] [--upload-pack=] [-q | --quiet] [--exit-code] [--get-url] [--sort=] [--symref] [ [...]] @@ -21,14 +21,16 @@ commit IDs. OPTIONS ------- --h:: ---heads:: +-b:: +--branches:: -t:: --tags:: - Limit to only refs/heads and refs/tags, respectively. + Limit to only local branches and local tags, respectively. These options are _not_ mutually exclusive; when given both, references stored in refs/heads and refs/tags are - displayed. Note that `git ls-remote -h` used without + displayed. Note that `--heads` and `-h` are deprecated + synonyms for `--branches` and `-b` and may be removed in + the future. Also note that `git ls-remote -h` used without anything else on the command line gives help, consistent with other git subcommands. diff --git a/builtin/ls-remote.c b/builtin/ls-remote.c index 65fb22a8a2..69841ed49f 100644 --- a/builtin/ls-remote.c +++ b/builtin/ls-remote.c @@ -9,7 +9,7 @@ #include "wildmatch.h" static const char * const ls_remote_usage[] = { - N_("git ls-remote [--heads] [--tags] [--refs] [--upload-pack=]\n" + N_("git ls-remote [--branches] [--tags] [--refs] [--upload-pack=]\n" " [-q | --quiet] [--exit-code] [--get-url] [--sort=]\n" " [--symref] [ [...]]"), NULL @@ -68,7 +68,10 @@ int cmd_ls_remote(int argc, const char **argv, const char *prefix) N_("path of git-upload-pack on the remote host"), PARSE_OPT_HIDDEN }, OPT_BIT('t', "tags", &flags, N_("limit to tags"), REF_TAGS), - OPT_BIT('h', "heads", &flags, N_("limit to heads"), REF_BRANCHES), + OPT_BIT('b', "branches", &flags, N_("limit to branches"), REF_BRANCHES), + OPT_BIT_F('h', "heads", &flags, + N_("deprecated synonym for --branches"), REF_BRANCHES, + PARSE_OPT_HIDDEN), OPT_BIT(0, "refs", &flags, N_("do not show peeled tags"), REF_NORMAL), OPT_BOOL(0, "get-url", &get_url, N_("take url..insteadOf into account")), diff --git a/t/t5512-ls-remote.sh b/t/t5512-ls-remote.sh index 5dbe107ce8..42e77eb5a9 100755 --- a/t/t5512-ls-remote.sh +++ b/t/t5512-ls-remote.sh @@ -47,6 +47,7 @@ test_expect_success setup ' git show-ref -d >refs && sed -e "s/ / /" refs >>expected.all && + grep refs/heads/ expected.all >expected.branches && git remote add self "$(pwd)/.git" && git remote add self2 "." ' @@ -71,6 +72,27 @@ test_expect_success 'ls-remote self' ' test_cmp expected.all actual ' +test_expect_success 'ls-remote --branches self' ' + git ls-remote --branches self >actual && + test_cmp expected.branches actual && + git ls-remote -b self >actual && + test_cmp expected.branches actual +' + +test_expect_success 'ls-remote -h is deprecated w/o warning' ' + git ls-remote -h self >actual 2>warning && + test_cmp expected.branches actual && + test_grep ! deprecated warning +' + +test_expect_success 'ls-remote --heads is deprecated and hidden w/o warning' ' + test_expect_code 129 git ls-remote -h >short-help && + test_grep ! -e --head short-help && + git ls-remote --heads self >actual 2>warning && + test_cmp expected.branches actual && + test_grep ! deprecated warning +' + test_expect_success 'ls-remote --sort="version:refname" --tags self' ' generate_references \ refs/tags/mark \ @@ -275,7 +297,7 @@ test_expect_success 'ls-remote with filtered symref (refname)' ' test_cmp expect actual ' -test_expect_success 'ls-remote with filtered symref (--heads)' ' +test_expect_success 'ls-remote with filtered symref (--branches)' ' git symbolic-ref refs/heads/foo refs/tags/mark && cat >expect.v2 <<-EOF && ref: refs/tags/mark refs/heads/foo @@ -283,9 +305,9 @@ test_expect_success 'ls-remote with filtered symref (--heads)' ' $rev refs/heads/main EOF grep -v "^ref: refs/tags/" expect.v0 && - git -c protocol.version=0 ls-remote --symref --heads . >actual.v0 && + git -c protocol.version=0 ls-remote --symref --branches . >actual.v0 && test_cmp expect.v0 actual.v0 && - git -c protocol.version=2 ls-remote --symref --heads . >actual.v2 && + git -c protocol.version=2 ls-remote --symref --branches . >actual.v2 && test_cmp expect.v2 actual.v2 ' @@ -335,9 +357,9 @@ test_expect_success 'ls-remote patterns work with all protocol versions' ' test_expect_success 'ls-remote prefixes work with all protocol versions' ' git for-each-ref --format="%(objectname) %(refname)" \ refs/heads/ refs/tags/ >expect && - git -c protocol.version=0 ls-remote --heads --tags . >actual.v0 && + git -c protocol.version=0 ls-remote --branches --tags . >actual.v0 && test_cmp expect actual.v0 && - git -c protocol.version=2 ls-remote --heads --tags . >actual.v2 && + git -c protocol.version=2 ls-remote --branches --tags . >actual.v2 && test_cmp expect actual.v2 ' -- 2.45.2-409-g7b0defb391 ``` ## Junio C Hamano, 2024-06-04 22:01 Subject: [PATCH v2 3/3] show-ref: introduce --branches and deprecate --heads Message-ID: <20240604220145.3260714-4-gitster@pobox.com> URL: https://gitlist.dev/e/20240604220145.3260714-4-gitster%40pobox.com In-Reply-To: <20240604220145.3260714-1-gitster@pobox.com> ``` We call the tips of branches "heads", but this command calls the option to show only branches "--heads", which confuses the branches themselves and the tips of branches. Straighten the terminology by introducing "--branches" option that limits the output to branches, and deprecate "--heads" option used that way. We do not plan to remove "--heads" or "-h" yet; we may want to do so at Git 3.0, in which case, we may need to start advertising upcoming removal with an extra warning when they are used. Signed-off-by: Junio C Hamano --- Documentation/git-show-ref.txt | 18 ++++++++++-------- builtin/show-ref.c | 16 +++++++++------- t/t1403-show-ref.sh | 24 ++++++++++++++++-------- 3 files changed, 35 insertions(+), 23 deletions(-) diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt index ba75747005..616d919655 100644 --- a/Documentation/git-show-ref.txt +++ b/Documentation/git-show-ref.txt @@ -9,8 +9,8 @@ SYNOPSIS -------- [verse] 'git show-ref' [--head] [-d | --dereference] - [-s | --hash[=]] [--abbrev[=]] [--tags] - [--heads] [--] [...] + [-s | --hash[=]] [--abbrev[=]] [--branches] [--tags] + [--] [...] 'git show-ref' --verify [-q | --quiet] [-d | --dereference] [-s | --hash[=]] [--abbrev[=]] [--] [...] @@ -45,12 +45,14 @@ OPTIONS Show the HEAD reference, even if it would normally be filtered out. ---heads:: +--branches:: --tags:: - Limit to "refs/heads" and "refs/tags", respectively. These options + Limit to local branches and local tags, respectively. These options are not mutually exclusive; when given both, references stored in - "refs/heads" and "refs/tags" are displayed. + "refs/heads" and "refs/tags" are displayed. Note that `--heads` + is a deprecated synonym for `--branches` and may be removed + in the future. -d:: --dereference:: @@ -139,7 +141,7 @@ When using `--hash` (and not `--dereference`), the output is in the format: For example, ----------------------------------------------------------------------------- -$ git show-ref --heads --hash +$ git show-ref --branches --hash 2e3ba0114a1f52b47df29743d6915d056be13278 185008ae97960c8d551adcd9e23565194651b5d1 03adf42c988195b50e1a1935ba5fcbc39b2b029b @@ -183,8 +185,8 @@ to check whether a particular branch exists or not (notice how we don't actually want to show any results, and we want to use the full refname for it in order to not trigger the problem with ambiguous partial matches). -To show only tags, or only proper branch heads, use `--tags` and/or `--heads` -respectively (using both means that it shows tags and heads, but not other +To show only tags, or only proper branch heads, use `--tags` and/or `--branches` +respectively (using both means that it shows tags and branches, but not other random references under the refs/ subdirectory). To do automatic tag object dereferencing, use the `-d` or `--dereference` diff --git a/builtin/show-ref.c b/builtin/show-ref.c index 1c15421e60..f634bc3e44 100644 --- a/builtin/show-ref.c +++ b/builtin/show-ref.c @@ -11,8 +11,8 @@ static const char * const show_ref_usage[] = { N_("git show-ref [--head] [-d | --dereference]\n" - " [-s | --hash[=]] [--abbrev[=]] [--tags]\n" - " [--heads] [--] [...]"), + " [-s | --hash[=]] [--abbrev[=]] [--branches] [--tags]\n" + " [--] [...]"), N_("git show-ref --verify [-q | --quiet] [-d | --dereference]\n" " [-s | --hash[=]] [--abbrev[=]]\n" " [--] [...]"), @@ -188,7 +188,7 @@ static int cmd_show_ref__verify(const struct show_one_options *show_one_opts, struct patterns_options { int show_head; - int heads_only; + int branches_only; int tags_only; }; @@ -206,8 +206,8 @@ static int cmd_show_ref__patterns(const struct patterns_options *opts, if (opts->show_head) head_ref(show_ref, &show_ref_data); - if (opts->heads_only || opts->tags_only) { - if (opts->heads_only) + if (opts->branches_only || opts->tags_only) { + if (opts->branches_only) for_each_fullref_in("refs/heads/", show_ref, &show_ref_data); if (opts->tags_only) for_each_fullref_in("refs/tags/", show_ref, &show_ref_data); @@ -286,8 +286,10 @@ int cmd_show_ref(int argc, const char **argv, const char *prefix) struct show_one_options show_one_opts = {0}; int verify = 0, exists = 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, "tags", &patterns_opts.tags_only, N_("only show tags (can be combined with branches)")), + OPT_BOOL(0, "branches", &patterns_opts.branches_only, N_("only show branches (can be combined with tags)")), + OPT_HIDDEN_BOOL(0, "heads", &patterns_opts.branches_only, + N_("deprecated synonym for --branches")), OPT_BOOL(0, "exists", &exists, N_("check for reference existence without resolving")), OPT_BOOL(0, "verify", &verify, N_("stricter reference checking, " "requires exact ref path")), diff --git a/t/t1403-show-ref.sh b/t/t1403-show-ref.sh index 33fb7a38ff..403f6b8f7d 100755 --- a/t/t1403-show-ref.sh +++ b/t/t1403-show-ref.sh @@ -121,13 +121,13 @@ test_expect_success 'show-ref -d' ' ' -test_expect_success 'show-ref --heads, --tags, --head, pattern' ' +test_expect_success 'show-ref --branches, --tags, --head, pattern' ' for branch in B main side do echo $(git rev-parse refs/heads/$branch) refs/heads/$branch || return 1 - done >expect.heads && - git show-ref --heads >actual && - test_cmp expect.heads actual && + done >expect.branches && + git show-ref --branches >actual && + test_cmp expect.branches actual && for tag in A B C do @@ -136,15 +136,15 @@ test_expect_success 'show-ref --heads, --tags, --head, pattern' ' git show-ref --tags >actual && test_cmp expect.tags actual && - cat expect.heads expect.tags >expect && - git show-ref --heads --tags >actual && + cat expect.branches expect.tags >expect && + git show-ref --branches --tags >actual && test_cmp expect actual && { echo $(git rev-parse HEAD) HEAD && - cat expect.heads expect.tags + cat expect.branches expect.tags } >expect && - git show-ref --heads --tags --head >actual && + git show-ref --branches --tags --head >actual && test_cmp expect actual && { @@ -165,6 +165,14 @@ test_expect_success 'show-ref --heads, --tags, --head, pattern' ' test_cmp expect actual ' +test_expect_success 'show-ref --heads is deprecated and hidden' ' + test_expect_code 129 git show-ref -h >short-help && + test_grep ! -e --heads short-help && + git show-ref --heads >actual 2>warning && + test_grep ! deprecated warning && + test_cmp expect.branches actual +' + test_expect_success 'show-ref --verify HEAD' ' echo $(git rev-parse HEAD) HEAD >expect && git show-ref --verify HEAD >actual && -- 2.45.2-409-g7b0defb391 ``` ## Patrick Steinhardt, 2024-06-06 09:39 Subject: Re: [PATCH v2 2/3] ls-remote: introduce --branches and deprecate --heads Message-ID: URL: https://gitlist.dev/e/ZmGDuThKIbexY-xa%40tanuki In-Reply-To: <20240604220145.3260714-3-gitster@pobox.com> ``` On Tue, Jun 04, 2024 at 03:01:44PM -0700, Junio C Hamano wrote: > diff --git a/builtin/ls-remote.c b/builtin/ls-remote.c > index 65fb22a8a2..69841ed49f 100644 > --- a/builtin/ls-remote.c > +++ b/builtin/ls-remote.c > @@ -9,7 +9,7 @@ > #include "wildmatch.h" > > static const char * const ls_remote_usage[] = { > - N_("git ls-remote [--heads] [--tags] [--refs] [--upload-pack=]\n" > + N_("git ls-remote [--branches] [--tags] [--refs] [--upload-pack=]\n" > " [-q | --quiet] [--exit-code] [--get-url] [--sort=]\n" > " [--symref] [ [...]]"), > NULL > @@ -68,7 +68,10 @@ int cmd_ls_remote(int argc, const char **argv, const char *prefix) > N_("path of git-upload-pack on the remote host"), > PARSE_OPT_HIDDEN }, > OPT_BIT('t', "tags", &flags, N_("limit to tags"), REF_TAGS), > - OPT_BIT('h', "heads", &flags, N_("limit to heads"), REF_BRANCHES), > + OPT_BIT('b', "branches", &flags, N_("limit to branches"), REF_BRANCHES), > + OPT_BIT_F('h', "heads", &flags, > + N_("deprecated synonym for --branches"), REF_BRANCHES, > + PARSE_OPT_HIDDEN), > OPT_BIT(0, "refs", &flags, N_("do not show peeled tags"), REF_NORMAL), > OPT_BOOL(0, "get-url", &get_url, > N_("take url..insteadOf into account")), > diff --git a/t/t5512-ls-remote.sh b/t/t5512-ls-remote.sh > index 5dbe107ce8..42e77eb5a9 100755 > --- a/t/t5512-ls-remote.sh > +++ b/t/t5512-ls-remote.sh > @@ -47,6 +47,7 @@ test_expect_success setup ' > git show-ref -d >refs && > sed -e "s/ / /" refs >>expected.all && > > + grep refs/heads/ expected.all >expected.branches && > git remote add self "$(pwd)/.git" && > git remote add self2 "." > ' > @@ -71,6 +72,27 @@ test_expect_success 'ls-remote self' ' > test_cmp expected.all actual > ' > > +test_expect_success 'ls-remote --branches self' ' > + git ls-remote --branches self >actual && > + test_cmp expected.branches actual && > + git ls-remote -b self >actual && > + test_cmp expected.branches actual > +' > + > +test_expect_success 'ls-remote -h is deprecated w/o warning' ' > + git ls-remote -h self >actual 2>warning && > + test_cmp expected.branches actual && > + test_grep ! deprecated warning > +' It is a bit funny to grep for something that wasn't ever there. But I don't mind it much as we may eventually want to introduce such a deprecation warning if we ever decide to go through with the deprecation. Patrick ``` ## Patrick Steinhardt, 2024-06-06 09:39 Subject: Re: [PATCH v2 0/3] Branches are branches and not heads Message-ID: URL: https://gitlist.dev/e/ZmGDvtZKHdkVD6qL%40tanuki In-Reply-To: <20240604220145.3260714-1-gitster@pobox.com> ``` On Tue, Jun 04, 2024 at 03:01:42PM -0700, Junio C Hamano wrote: > tl;dr for those who did read v1: v2 does not warn when deprecated > variants are used. > ---------------------- > > Back when Git started, we used the word "head" to mean the tip of > possibly multiple histories, and that is where the name of the > hierarchy .git/refs/heads/ came from. But these days we call these > entities "branches" in human terms, and "head" is still used to > refer to the tip of the history each of these branches represent. > > When asking "git ls-remote" or "git show-ref" to limit their output > to branches (as opposed to showing any ref), we use "--heads" for > historical reasons, but give the option a more human friendly name > "--branches", and demote "--heads" to the status of a deprecated > synonym. > > We do not plan to remove "--heads" or "-h" yet, but we may want to > do so at the Git 3.0 boundary, in which case we will need to start > advertising upcoming removal with an extra warning when they are > used. But let's not start annoying users for now. This version looks good to me, thanks! Patrick ``` ## Junio C Hamano, 2024-06-06 15:18 Subject: Re: [PATCH v2 2/3] ls-remote: introduce --branches and deprecate --heads Message-ID: URL: https://gitlist.dev/e/xmqqa5jyp0al.fsf%40gitster.g In-Reply-To: ``` Patrick Steinhardt writes: >> +test_expect_success 'ls-remote -h is deprecated w/o warning' ' >> + git ls-remote -h self >actual 2>warning && >> + test_cmp expected.branches actual && >> + test_grep ! deprecated warning >> +' > > It is a bit funny to grep for something that wasn't ever there. But I > don't mind it much as we may eventually want to introduce such a > deprecation warning if we ever decide to go through with the > deprecation. It is indeed funny. We thought about adding and then made a conscious decision not to add a deprecation warning, so this testpiece serves as a documentation of the status quo, and a back-pointer for readers to blame back to the message of the commit that introduced this one, which clearly says the lack of warning is something we may want to reconsider later. So, this should be fine (the same for 3/3). Thanks. ``` ## Elijah Newren, 2024-06-14 19:32 Subject: Re: [PATCH v2 3/3] show-ref: introduce --branches and deprecate --heads Message-ID: URL: https://gitlist.dev/e/CABPp-BH3ZozGnDueK%3DJ4QvZMYZkS13Gk%2B0rhe%2BDywqbx1F30DA%40mail.gmail.com In-Reply-To: <20240604220145.3260714-4-gitster@pobox.com> ``` On Tue, Jun 4, 2024 at 10:02 PM Junio C Hamano wrote: > > We call the tips of branches "heads", but this command calls the > option to show only branches "--heads", which confuses the branches > themselves and the tips of branches. > > Straighten the terminology by introducing "--branches" option that > limits the output to branches, and deprecate "--heads" option used > that way. > > We do not plan to remove "--heads" or "-h" yet; we may want to do so > at Git 3.0, in which case, we may need to start advertising upcoming > removal with an extra warning when they are used. > > Signed-off-by: Junio C Hamano > --- > Documentation/git-show-ref.txt | 18 ++++++++++-------- > builtin/show-ref.c | 16 +++++++++------- > t/t1403-show-ref.sh | 24 ++++++++++++++++-------- > 3 files changed, 35 insertions(+), 23 deletions(-) > > diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt > index ba75747005..616d919655 100644 > --- a/Documentation/git-show-ref.txt > +++ b/Documentation/git-show-ref.txt > @@ -9,8 +9,8 @@ SYNOPSIS > -------- > [verse] > 'git show-ref' [--head] [-d | --dereference] > - [-s | --hash[=]] [--abbrev[=]] [--tags] > - [--heads] [--] [...] > + [-s | --hash[=]] [--abbrev[=]] [--branches] [--tags] > + [--] [...] > 'git show-ref' --verify [-q | --quiet] [-d | --dereference] > [-s | --hash[=]] [--abbrev[=]] > [--] [...] > @@ -45,12 +45,14 @@ OPTIONS > > Show the HEAD reference, even if it would normally be filtered out. > > ---heads:: > +--branches:: > --tags:: > > - Limit to "refs/heads" and "refs/tags", respectively. These options > + Limit to local branches and local tags, respectively. These options > are not mutually exclusive; when given both, references stored in > - "refs/heads" and "refs/tags" are displayed. > + "refs/heads" and "refs/tags" are displayed. Note that `--heads` > + is a deprecated synonym for `--branches` and may be removed > + in the future. > > -d:: > --dereference:: > @@ -139,7 +141,7 @@ When using `--hash` (and not `--dereference`), the output is in the format: > For example, > > ----------------------------------------------------------------------------- > -$ git show-ref --heads --hash > +$ git show-ref --branches --hash > 2e3ba0114a1f52b47df29743d6915d056be13278 > 185008ae97960c8d551adcd9e23565194651b5d1 > 03adf42c988195b50e1a1935ba5fcbc39b2b029b > @@ -183,8 +185,8 @@ to check whether a particular branch exists or not (notice how we don't > actually want to show any results, and we want to use the full refname for it > in order to not trigger the problem with ambiguous partial matches). > > -To show only tags, or only proper branch heads, use `--tags` and/or `--heads` > -respectively (using both means that it shows tags and heads, but not other > +To show only tags, or only proper branch heads, use `--tags` and/or `--branches` > +respectively (using both means that it shows tags and branches, but not other > random references under the refs/ subdirectory). > > To do automatic tag object dereferencing, use the `-d` or `--dereference` > diff --git a/builtin/show-ref.c b/builtin/show-ref.c > index 1c15421e60..f634bc3e44 100644 > --- a/builtin/show-ref.c > +++ b/builtin/show-ref.c > @@ -11,8 +11,8 @@ > > static const char * const show_ref_usage[] = { > N_("git show-ref [--head] [-d | --dereference]\n" > - " [-s | --hash[=]] [--abbrev[=]] [--tags]\n" > - " [--heads] [--] [...]"), > + " [-s | --hash[=]] [--abbrev[=]] [--branches] [--tags]\n" > + " [--] [...]"), > N_("git show-ref --verify [-q | --quiet] [-d | --dereference]\n" > " [-s | --hash[=]] [--abbrev[=]]\n" > " [--] [...]"), > @@ -188,7 +188,7 @@ static int cmd_show_ref__verify(const struct show_one_options *show_one_opts, > > struct patterns_options { > int show_head; > - int heads_only; > + int branches_only; > int tags_only; > }; > > @@ -206,8 +206,8 @@ static int cmd_show_ref__patterns(const struct patterns_options *opts, > > if (opts->show_head) > head_ref(show_ref, &show_ref_data); > - if (opts->heads_only || opts->tags_only) { > - if (opts->heads_only) > + if (opts->branches_only || opts->tags_only) { > + if (opts->branches_only) > for_each_fullref_in("refs/heads/", show_ref, &show_ref_data); > if (opts->tags_only) > for_each_fullref_in("refs/tags/", show_ref, &show_ref_data); > @@ -286,8 +286,10 @@ int cmd_show_ref(int argc, const char **argv, const char *prefix) > struct show_one_options show_one_opts = {0}; > int verify = 0, exists = 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, "tags", &patterns_opts.tags_only, N_("only show tags (can be combined with branches)")), > + OPT_BOOL(0, "branches", &patterns_opts.branches_only, N_("only show branches (can be combined with tags)")), > + OPT_HIDDEN_BOOL(0, "heads", &patterns_opts.branches_only, > + N_("deprecated synonym for --branches")), > OPT_BOOL(0, "exists", &exists, N_("check for reference existence without resolving")), > OPT_BOOL(0, "verify", &verify, N_("stricter reference checking, " > "requires exact ref path")), > diff --git a/t/t1403-show-ref.sh b/t/t1403-show-ref.sh > index 33fb7a38ff..403f6b8f7d 100755 > --- a/t/t1403-show-ref.sh > +++ b/t/t1403-show-ref.sh > @@ -121,13 +121,13 @@ test_expect_success 'show-ref -d' ' > > ' > > -test_expect_success 'show-ref --heads, --tags, --head, pattern' ' > +test_expect_success 'show-ref --branches, --tags, --head, pattern' ' > for branch in B main side > do > echo $(git rev-parse refs/heads/$branch) refs/heads/$branch || return 1 > - done >expect.heads && > - git show-ref --heads >actual && > - test_cmp expect.heads actual && > + done >expect.branches && > + git show-ref --branches >actual && > + test_cmp expect.branches actual && > > for tag in A B C > do > @@ -136,15 +136,15 @@ test_expect_success 'show-ref --heads, --tags, --head, pattern' ' > git show-ref --tags >actual && > test_cmp expect.tags actual && > > - cat expect.heads expect.tags >expect && > - git show-ref --heads --tags >actual && > + cat expect.branches expect.tags >expect && > + git show-ref --branches --tags >actual && > test_cmp expect actual && > > { > echo $(git rev-parse HEAD) HEAD && > - cat expect.heads expect.tags > + cat expect.branches expect.tags > } >expect && > - git show-ref --heads --tags --head >actual && > + git show-ref --branches --tags --head >actual && > test_cmp expect actual && > > { > @@ -165,6 +165,14 @@ test_expect_success 'show-ref --heads, --tags, --head, pattern' ' > test_cmp expect actual > ' > > +test_expect_success 'show-ref --heads is deprecated and hidden' ' > + test_expect_code 129 git show-ref -h >short-help && > + test_grep ! -e --heads short-help && > + git show-ref --heads >actual 2>warning && > + test_grep ! deprecated warning && > + test_cmp expect.branches actual > +' > + > test_expect_success 'show-ref --verify HEAD' ' > echo $(git rev-parse HEAD) HEAD >expect && > git show-ref --verify HEAD >actual && > -- > 2.45.2-409-g7b0defb391 If we are renaming --heads to --branches, should --head also be renamed? Other than that question, this patch and series looks good to me. ``` ## Junio C Hamano, 2024-06-14 21:21 Subject: Re: [PATCH v2 3/3] show-ref: introduce --branches and deprecate --heads Message-ID: URL: https://gitlist.dev/e/xmqq7cerdxv4.fsf%40gitster.g In-Reply-To: ``` Elijah Newren writes: > If we are renaming --heads to --branches, should --head also be renamed? I do not think so. It is specifically about HEAD (the thing that lives above refs/ hierarchy, historically implemented as a file whose name is "HEAD" that is directly inside $GIT_DIR). Thanks. ``` ## Elijah Newren, 2024-06-14 21:34 Subject: Re: [PATCH v2 3/3] show-ref: introduce --branches and deprecate --heads Message-ID: URL: https://gitlist.dev/e/CABPp-BEM4fqU9s7_dxgi_twe_T169mGjZN9-CJRLU5cjnUi8WQ%40mail.gmail.com In-Reply-To: ``` On Fri, Jun 14, 2024 at 9:21 PM Junio C Hamano wrote: > > Elijah Newren writes: > > > If we are renaming --heads to --branches, should --head also be renamed? > > I do not think so. It is specifically about HEAD (the thing that > lives above refs/ hierarchy, historically implemented as a file > whose name is "HEAD" that is directly inside $GIT_DIR). > > Thanks. I'm fine if we don't want to rename it, but I don't quite follow this particular rationale. The logic you use here seems to be about internal details ("it's the file named HEAD") and ignores what users might refer to it as ("current branch"), whereas --branches ignored the internal details ("the files under refs/heads/") and instead concentrates on what users might refer to them as ("branches") and used that as the rationale for renaming. That said, I've almost never seen users use --head (and haven't used it myself), whereas asking for heads/branches is much more common, and I'm very happy with the change from --heads to --branches. Also, even if we do agree --head should be renamed, I'd be fine with punting it to later in order to get this improvement in now...it just seemed like a small inconsistency that I thought was worth pointing out. ``` ## Elijah Newren, 2024-06-14 21:42 Subject: Re: [PATCH v2 3/3] show-ref: introduce --branches and deprecate --heads Message-ID: URL: https://gitlist.dev/e/CABPp-BEZhR8T56bwxpi%2B_uGG8w7nms%2B7HtCR45S4oVjPom9Stg%40mail.gmail.com In-Reply-To: ``` On Fri, Jun 14, 2024 at 9:34 PM Elijah Newren wrote: > > On Fri, Jun 14, 2024 at 9:21 PM Junio C Hamano wrote: > > > > Elijah Newren writes: > > > > > If we are renaming --heads to --branches, should --head also be renamed? > > > > I do not think so. It is specifically about HEAD (the thing that > > lives above refs/ hierarchy, historically implemented as a file > > whose name is "HEAD" that is directly inside $GIT_DIR). > > > > Thanks. > > I'm fine if we don't want to rename it, but I don't quite follow this > particular rationale. The logic you use here seems to be about > internal details ("it's the file named HEAD") and ignores what users > might refer to it as ("current branch"), whereas --branches ignored > the internal details ("the files under refs/heads/") and instead > concentrates on what users might refer to them as ("branches") and > used that as the rationale for renaming. > > That said, I've almost never seen users use --head (and haven't used > it myself), whereas asking for heads/branches is much more common, and > I'm very happy with the change from --heads to --branches. Also, even > if we do agree --head should be renamed, I'd be fine with punting it > to later in order to get this improvement in now...it just seemed like > a small inconsistency that I thought was worth pointing out. ...or maybe my argument breaks down because `HEAD` is more prominent and tends to be used by users more (`git reset --hard HEAD`, `git checkout HEAD~1`), and thus there's an argument it already is somewhat aligned with user terminology? ``` ## Junio C Hamano, 2024-06-14 22:46 Subject: Re: [PATCH v2 3/3] show-ref: introduce --branches and deprecate --heads Message-ID: URL: https://gitlist.dev/e/xmqq5xubcfco.fsf%40gitster.g In-Reply-To: ``` Elijah Newren writes: > ...or maybe my argument breaks down because `HEAD` is more prominent > and tends to be used by users more (`git reset --hard HEAD`, `git > checkout HEAD~1`), and thus there's an argument it already is somewhat > aligned with user terminology? Yeah, you are correct to say that HEAD is a lot more prominent than "refs/heads/". "git branch --list" does not expose the "refs/heads/" part (but "git for-each-ref" does), but you'd see HEAD in many places (e.g. "git show -s " gives the --decorate output that says "HEAD -> master" etc.). Of course we _could_ plan to rename "HEAD" to something else, like "CURRENT" and deal with the fallout, and then rename "refs/heads/" to "refs/branches/", but for what cost to achieve what benefit? The tradeoff does not look all that good to me. So I'd say renaming --heads to --branches would probably be a good place to stop, at least for now. ```