From: "Thomas Weißschuh" <thomas@t-8ch.de>
To: git@vger.kernel.org
Cc: "Thomas Weißschuh" <thomas@t-8ch.de>
Subject: [PATCH] builtin: add git-default-branch command
Date: Sat, 30 Oct 2021 16:01:12 +0200 [thread overview]
Message-ID: <20211030140112.834650-1-thomas@t-8ch.de> (raw)
Introduce command `default-branch` which allows to retrieve the branch
that will be used by git-init.
Currently this command 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.
Signed-off-by: Thomas Weißschuh <thomas@t-8ch.de>
---
.gitignore | 1 +
Documentation/git-default-branch.txt | 15 +++++++++++++
Makefile | 1 +
builtin.h | 1 +
builtin/default-branch.c | 33 ++++++++++++++++++++++++++++
command-list.txt | 1 +
git.c | 1 +
t/t1417-default-branch.sh | 21 ++++++++++++++++++
8 files changed, 74 insertions(+)
create mode 100644 Documentation/git-default-branch.txt
create mode 100644 builtin/default-branch.c
create mode 100755 t/t1417-default-branch.sh
diff --git a/.gitignore b/.gitignore
index 311841f9be..d9b969dc7e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -53,6 +53,7 @@
/git-cvsimport
/git-cvsserver
/git-daemon
+/git-default-branch
/git-diff
/git-diff-files
/git-diff-index
diff --git a/Documentation/git-default-branch.txt b/Documentation/git-default-branch.txt
new file mode 100644
index 0000000000..d5b891e5b4
--- /dev/null
+++ b/Documentation/git-default-branch.txt
@@ -0,0 +1,15 @@
+git-default-branch(1)
+===================
+
+NAME
+----
+git-default-branch - Read the default branch ref used by git
+
+SYNOPSIS
+--------
+[verse]
+'git default-branch'
+
+GIT
+---
+Part of the linkgit:git[1] suite
diff --git a/Makefile b/Makefile
index d1feab008f..49276359ab 100644
--- a/Makefile
+++ b/Makefile
@@ -1091,6 +1091,7 @@ BUILTIN_OBJS += builtin/credential-cache.o
BUILTIN_OBJS += builtin/credential-store.o
BUILTIN_OBJS += builtin/credential.o
BUILTIN_OBJS += builtin/describe.o
+BUILTIN_OBJS += builtin/default-branch.o
BUILTIN_OBJS += builtin/diff-files.o
BUILTIN_OBJS += builtin/diff-index.o
BUILTIN_OBJS += builtin/diff-tree.o
diff --git a/builtin.h b/builtin.h
index 16ecd5586f..65b41e4c1f 100644
--- a/builtin.h
+++ b/builtin.h
@@ -143,6 +143,7 @@ int cmd_credential(int argc, const char **argv, const char *prefix);
int cmd_credential_cache(int argc, const char **argv, const char *prefix);
int cmd_credential_cache_daemon(int argc, const char **argv, const char *prefix);
int cmd_credential_store(int argc, const char **argv, const char *prefix);
+int cmd_default_branch(int argc, const char **argv, const char *prefix);
int cmd_describe(int argc, const char **argv, const char *prefix);
int cmd_diff_files(int argc, const char **argv, const char *prefix);
int cmd_diff_index(int argc, const char **argv, const char *prefix);
diff --git a/builtin/default-branch.c b/builtin/default-branch.c
new file mode 100644
index 0000000000..e74c078926
--- /dev/null
+++ b/builtin/default-branch.c
@@ -0,0 +1,33 @@
+#include "builtin.h"
+#include "config.h"
+#include "refs.h"
+#include "parse-options.h"
+
+static const char * const git_default_branch_usage[] = {
+ N_("git default-branch"),
+ NULL
+};
+
+
+int cmd_default_branch(int argc, const char **argv, const char *prefix)
+{
+ char *name;
+
+ struct option options[] = {
+ OPT_END(),
+ };
+
+ argc = parse_options(argc, argv, prefix, options,
+ git_default_branch_usage, 0);
+
+ if (argc != 0)
+ usage_with_options(git_default_branch_usage, options);
+
+ name = repo_default_branch_name(the_repository, 1);
+
+ if (!name)
+ die("Could not fetch default branch name");
+
+ puts(name);
+ return 0;
+}
diff --git a/command-list.txt b/command-list.txt
index a289f09ed6..950fa9a993 100644
--- a/command-list.txt
+++ b/command-list.txt
@@ -81,6 +81,7 @@ git-cvsexportcommit foreignscminterface
git-cvsimport foreignscminterface
git-cvsserver foreignscminterface
git-daemon synchingrepositories
+git-default-branch plumbinginterrogators
git-describe mainporcelain
git-diff mainporcelain info
git-diff-files plumbinginterrogators
diff --git a/git.c b/git.c
index 18bed9a996..112f37a7f3 100644
--- a/git.c
+++ b/git.c
@@ -516,6 +516,7 @@ static struct cmd_struct commands[] = {
{ "credential-cache", cmd_credential_cache },
{ "credential-cache--daemon", cmd_credential_cache_daemon },
{ "credential-store", cmd_credential_store },
+ { "default-branch", cmd_default_branch, RUN_SETUP_GENTLY },
{ "describe", cmd_describe, RUN_SETUP },
{ "diff", cmd_diff, NO_PARSEOPT },
{ "diff-files", cmd_diff_files, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
diff --git a/t/t1417-default-branch.sh b/t/t1417-default-branch.sh
new file mode 100755
index 0000000000..d81f1ee214
--- /dev/null
+++ b/t/t1417-default-branch.sh
@@ -0,0 +1,21 @@
+#!/bin/sh
+
+test_description='Test git default-branch'
+
+. ./test-lib.sh
+
+unset GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME
+
+test_expect_success 'without configuration' '
+ b=$(git default-branch) &&
+ verbose test "$b" = master
+'
+
+test_expect_success 'with configuration' '
+ git config init.defaultbranch foo &&
+ b=$(git default-branch) &&
+ echo $b &&
+ verbose test "$b" = foo
+'
+
+test_done
base-commit: 6c40894d2466d4e7fddc047a05116aa9d14712ee
--
2.33.1
next reply other threads:[~2021-10-30 14:01 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-30 14:01 Thomas Weißschuh [this message]
2021-10-30 17:18 ` [PATCH] builtin: add git-default-branch command Ævar Arnfjörð Bjarmason
2021-11-02 13:39 ` Johannes Schindelin
2021-11-02 16:44 ` [PATCH v2] var: add GIT_DEFAULT_BRANCH variable Thomas Weißschuh
2021-11-02 16:53 ` Ævar Arnfjörð Bjarmason
2021-11-02 17:35 ` Thomas Weißschuh
2021-11-02 19:14 ` Ævar Arnfjörð Bjarmason
2021-11-02 20:08 ` Thomas Weißschuh
2021-11-03 11:37 ` Jeff King
2021-11-03 16:48 ` Eric Sunshine
2021-11-03 18:21 ` Junio C Hamano
2021-11-03 18:53 ` [PATCH v3] " Thomas Weißschuh
2021-11-03 19:57 ` Eric Sunshine
2021-11-03 20:04 ` Junio C Hamano
2021-11-03 20:17 ` [PATCH v4] " Thomas Weißschuh
2021-11-03 20:23 ` Junio C Hamano
2021-11-03 17:22 ` [PATCH] builtin: add git-default-branch command Junio C Hamano
2021-11-03 23:44 ` Johannes Schindelin
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=20211030140112.834650-1-thomas@t-8ch.de \
--to=thomas@t-8ch.de \
--cc=git@vger.kernel.org \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.