var: add GIT_DEFAULT_BRANCH variable

Introduce the logical variable GIT_DEFAULT_BRANCH which represents the
the default branch name that will be used by "git init".

Currently this variable is equivalent to
    git config init.defaultbranch || 'master'

This however will break if at one point the default branch is changed as
indicated by `default_branch_name_advice` in `refs.c`.

By providing this command ahead of time users of git can make their
code forward-compatible.

Helped-by: Johannes Schindelin <Johannes.Schindelin@gmx.de>
Helped-by: Eric Sunshine <sunshine@sunshineco.com>
Helped-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Thomas Weißschuh <thomas@t-8ch.de>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
pull/790/merge
Thomas Weißschuh 11 months ago committed by Junio C Hamano
parent af6d1d602a
commit e06c9e1df2
  1. 3
      Documentation/git-var.txt
  2. 7
      builtin/var.c
  3. 20
      t/t0007-git-var.sh

@ -59,6 +59,9 @@ ifdef::git-default-pager[]
The build you are using chose '{git-default-pager}' as the default.
endif::git-default-pager[]
GIT_DEFAULT_BRANCH::
The name of the first branch created in newly initialized repositories.
SEE ALSO
--------
linkgit:git-commit-tree[1]

@ -5,6 +5,7 @@
*/
#include "builtin.h"
#include "config.h"
#include "refs.h"
static const char var_usage[] = "git var (-l | <variable>)";
@ -27,6 +28,11 @@ static const char *pager(int flag)
return pgm;
}
static const char *default_branch(int flag)
{
return git_default_branch_name(1);
}
struct git_var {
const char *name;
const char *(*read)(int);
@ -36,6 +42,7 @@ static struct git_var git_vars[] = {
{ "GIT_AUTHOR_IDENT", git_author_info },
{ "GIT_EDITOR", editor },
{ "GIT_PAGER", pager },
{ "GIT_DEFAULT_BRANCH", default_branch },
{ "", NULL },
};

@ -25,6 +25,26 @@ test_expect_success !FAIL_PREREQS,!AUTOIDENT 'requested identities are strict' '
)
'
test_expect_success 'get GIT_DEFAULT_BRANCH without configuration' '
(
sane_unset GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME &&
git init defbranch &&
git -C defbranch symbolic-ref --short HEAD >expect &&
git var GIT_DEFAULT_BRANCH >actual &&
test_cmp expect actual
)
'
test_expect_success 'get GIT_DEFAULT_BRANCH with configuration' '
test_config init.defaultbranch foo &&
(
sane_unset GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME &&
echo foo >expect &&
git var GIT_DEFAULT_BRANCH >actual &&
test_cmp expect actual
)
'
# For git var -l, we check only a representative variable;
# testing the whole output would make our test too brittle with
# respect to unrelated changes in the test suite's environment.

Loading…
Cancel
Save