From: Denton Liu <liu.denton@gmail.com>
To: Git Mailing List <git@vger.kernel.org>
Cc: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
"Junio C Hamano" <gitster@pobox.com>,
"Johannes Schindelin" <Johannes.Schindelin@gmx.de>,
"Duy Nguyen" <pclouds@gmail.com>
Subject: [PATCH v3] config: learn the "onbranch:" includeIf condition
Date: Wed, 5 Jun 2019 17:21:59 -0400 [thread overview]
Message-ID: <49e22269d5a66d1975fca71a300e9099f46e1c40.1559769658.git.liu.denton@gmail.com> (raw)
In-Reply-To: <3573995264441c50ea9529b3ee926d1ed3ec4ac8.1559330905.git.liu.denton@gmail.com>
Currently, if a user wishes to have individual settings per branch, they
are required to manually keep track of the settings in their head and
manually set the options on the command-line or change the config at
each branch.
Teach config the "onbranch:" includeIf condition so that it can
conditionally include configuration files if the branch that is checked
out in the current worktree matches the pattern given.
Signed-off-by: Denton Liu <liu.denton@gmail.com>
---
Thanks for the review, Johannes and Duy. I've incorporated both of your
suggestions into this round.
Notes:
Changes since v2:
* Run test-cases outside foo/ since the subdirectory is not necessary
* Implicitly add `**` when there is a trailing `/`
Changes since v1:
* Allow onbranch: to specify a pattern instead of just a static
comparison
Interdiff against v2:
diff --git a/Documentation/config.txt b/Documentation/config.txt
index 93aa4323c6..e3f5bc3396 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -145,11 +145,18 @@ refer to linkgit:gitignore[5] for details. For convenience:
case-insensitively (e.g. on case-insensitive file sytems)
`onbranch`::
- The data that follows the keyword `onbranch:` is taken to be a pattern
- with standard globbing wildcards and two additional ones, `**/` and
- `/**`, that can match multiple path components. If we are in a worktree
- where the name of the branch that is currently checked out matches the
- pattern, the include condition is met.
+ The data that follows the keyword `onbranch:` is taken to be a
+ pattern with standard globbing wildcards and two additional
+ ones, `**/` and `/**`, that can match multiple path components.
+ If we are in a worktree where the name of the branch that is
+ currently checked out matches the pattern, the include condition
+ is met.
++
+If the pattern ends with `/`, `**` will be automatically added. For
+example, the pattern `foo/` becomes `foo/**`. In other words, it matches
+all branches that begin with `foo/`. This is useful if your branches are
+organized hierarchically and you would like to apply a configuration to
+all the branches in that hierarchy.
A few more notes on matching via `gitdir` and `gitdir/i`:
diff --git a/config.c b/config.c
index 48bb435739..ad4166e243 100644
--- a/config.c
+++ b/config.c
@@ -171,6 +171,12 @@ static int handle_path_include(const char *path, struct config_include_data *inc
return ret;
}
+static void add_trailing_starstar_for_dir(struct strbuf *pat)
+{
+ if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
+ strbuf_addstr(pat, "**");
+}
+
static int prepare_include_condition_pattern(struct strbuf *pat)
{
struct strbuf path = STRBUF_INIT;
@@ -200,8 +206,7 @@ static int prepare_include_condition_pattern(struct strbuf *pat)
} else if (!is_absolute_path(pat->buf))
strbuf_insert(pat, 0, "**/", 3);
- if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
- strbuf_addstr(pat, "**");
+ add_trailing_starstar_for_dir(pat);
strbuf_release(&path);
return prefix;
@@ -278,6 +283,7 @@ static int include_by_branch(const char *cond, size_t cond_len)
return 0;
strbuf_add(&pattern, cond, cond_len);
+ add_trailing_starstar_for_dir(&pattern);
ret = !wildmatch(pattern.buf, shortname, WM_PATHNAME);
strbuf_release(&pattern);
return ret;
diff --git a/t/t1305-config-include.sh b/t/t1305-config-include.sh
index 05c7def1f2..9571e366f8 100755
--- a/t/t1305-config-include.sh
+++ b/t/t1305-config-include.sh
@@ -310,36 +310,42 @@ test_expect_success SYMLINKS 'conditional include, gitdir matching symlink, icas
'
test_expect_success 'conditional include, onbranch' '
- (
- cd bar &&
- echo "[includeIf \"onbranch:foo-branch\"]path=bar9" >>.git/config &&
- echo "[test]nine=9" >.git/bar9 &&
- git checkout -b master &&
- test_must_fail git config test.nine &&
- git checkout -b foo-branch &&
- echo 9 >expect &&
- git config test.nine >actual &&
- test_cmp expect actual
- )
+ echo "[includeIf \"onbranch:foo-branch\"]path=bar9" >>.git/config &&
+ echo "[test]nine=9" >.git/bar9 &&
+ git checkout -b master &&
+ test_must_fail git config test.nine &&
+ git checkout -b foo-branch &&
+ echo 9 >expect &&
+ git config test.nine >actual &&
+ test_cmp expect actual
'
test_expect_success 'conditional include, onbranch, wildcard' '
- (
- cd bar &&
- echo "[includeIf \"onbranch:?oo-*/**\"]path=bar10" >>.git/config &&
- echo "[test]ten=10" >.git/bar10 &&
- git checkout -b not-foo-branch/a &&
- test_must_fail git config test.ten &&
-
- echo 10 >expect &&
- git checkout -b foo-branch/a/b/c &&
- git config test.ten >actual &&
- test_cmp expect actual &&
-
- git checkout -b moo-bar/a &&
- git config test.ten >actual &&
- test_cmp expect actual
- )
+ echo "[includeIf \"onbranch:?oo-*/**\"]path=bar10" >>.git/config &&
+ echo "[test]ten=10" >.git/bar10 &&
+ git checkout -b not-foo-branch/a &&
+ test_must_fail git config test.ten &&
+
+ echo 10 >expect &&
+ git checkout -b foo-branch/a/b/c &&
+ git config test.ten >actual &&
+ test_cmp expect actual &&
+
+ git checkout -b moo-bar/a &&
+ git config test.ten >actual &&
+ test_cmp expect actual
+'
+
+test_expect_success 'conditional include, onbranch, implicit /** for /' '
+ echo "[includeIf \"onbranch:foo-dir/\"]path=bar11" >>.git/config &&
+ echo "[test]eleven=11" >.git/bar11 &&
+ git checkout -b not-foo-dir/a &&
+ test_must_fail git config test.eleven &&
+
+ echo 11 >expect &&
+ git checkout -b foo-dir/a/b/c &&
+ git config test.eleven >actual &&
+ test_cmp expect actual
'
test_expect_success 'include cycles are detected' '
Documentation/config.txt | 19 +++++++++++++++++++
config.c | 31 +++++++++++++++++++++++++++++--
t/t1305-config-include.sh | 39 +++++++++++++++++++++++++++++++++++++++
3 files changed, 87 insertions(+), 2 deletions(-)
diff --git a/Documentation/config.txt b/Documentation/config.txt
index 7e2a6f61f5..e3f5bc3396 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -144,6 +144,20 @@ refer to linkgit:gitignore[5] for details. For convenience:
This is the same as `gitdir` except that matching is done
case-insensitively (e.g. on case-insensitive file sytems)
+`onbranch`::
+ The data that follows the keyword `onbranch:` is taken to be a
+ pattern with standard globbing wildcards and two additional
+ ones, `**/` and `/**`, that can match multiple path components.
+ If we are in a worktree where the name of the branch that is
+ currently checked out matches the pattern, the include condition
+ is met.
++
+If the pattern ends with `/`, `**` will be automatically added. For
+example, the pattern `foo/` becomes `foo/**`. In other words, it matches
+all branches that begin with `foo/`. This is useful if your branches are
+organized hierarchically and you would like to apply a configuration to
+all the branches in that hierarchy.
+
A few more notes on matching via `gitdir` and `gitdir/i`:
* Symlinks in `$GIT_DIR` are not resolved before matching.
@@ -206,6 +220,11 @@ Example
[includeIf "gitdir:/path/to/group/"]
path = foo.inc
+ ; include only if we are in a worktree where foo-branch is
+ ; currently checked out
+ [includeIf "onbranch:foo-branch"]
+ path = foo.inc
+
Values
~~~~~~
diff --git a/config.c b/config.c
index 296a6d9cc4..ad4166e243 100644
--- a/config.c
+++ b/config.c
@@ -19,6 +19,7 @@
#include "utf8.h"
#include "dir.h"
#include "color.h"
+#include "refs.h"
struct config_source {
struct config_source *prev;
@@ -170,6 +171,12 @@ static int handle_path_include(const char *path, struct config_include_data *inc
return ret;
}
+static void add_trailing_starstar_for_dir(struct strbuf *pat)
+{
+ if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
+ strbuf_addstr(pat, "**");
+}
+
static int prepare_include_condition_pattern(struct strbuf *pat)
{
struct strbuf path = STRBUF_INIT;
@@ -199,8 +206,7 @@ static int prepare_include_condition_pattern(struct strbuf *pat)
} else if (!is_absolute_path(pat->buf))
strbuf_insert(pat, 0, "**/", 3);
- if (pat->len && is_dir_sep(pat->buf[pat->len - 1]))
- strbuf_addstr(pat, "**");
+ add_trailing_starstar_for_dir(pat);
strbuf_release(&path);
return prefix;
@@ -264,6 +270,25 @@ static int include_by_gitdir(const struct config_options *opts,
return ret;
}
+static int include_by_branch(const char *cond, size_t cond_len)
+{
+ int flags;
+ int ret;
+ struct strbuf pattern = STRBUF_INIT;
+ const char *refname = resolve_ref_unsafe("HEAD", 0, NULL, &flags);
+ const char *shortname;
+
+ if (!refname || !(flags & REF_ISSYMREF) ||
+ !skip_prefix(refname, "refs/heads/", &shortname))
+ return 0;
+
+ strbuf_add(&pattern, cond, cond_len);
+ add_trailing_starstar_for_dir(&pattern);
+ ret = !wildmatch(pattern.buf, shortname, WM_PATHNAME);
+ strbuf_release(&pattern);
+ return ret;
+}
+
static int include_condition_is_true(const struct config_options *opts,
const char *cond, size_t cond_len)
{
@@ -272,6 +297,8 @@ static int include_condition_is_true(const struct config_options *opts,
return include_by_gitdir(opts, cond, cond_len, 0);
else if (skip_prefix_mem(cond, cond_len, "gitdir/i:", &cond, &cond_len))
return include_by_gitdir(opts, cond, cond_len, 1);
+ else if (skip_prefix_mem(cond, cond_len, "onbranch:", &cond, &cond_len))
+ return include_by_branch(cond, cond_len);
/* unknown conditionals are always false */
return 0;
diff --git a/t/t1305-config-include.sh b/t/t1305-config-include.sh
index 579a86b7f8..9571e366f8 100755
--- a/t/t1305-config-include.sh
+++ b/t/t1305-config-include.sh
@@ -309,6 +309,45 @@ test_expect_success SYMLINKS 'conditional include, gitdir matching symlink, icas
)
'
+test_expect_success 'conditional include, onbranch' '
+ echo "[includeIf \"onbranch:foo-branch\"]path=bar9" >>.git/config &&
+ echo "[test]nine=9" >.git/bar9 &&
+ git checkout -b master &&
+ test_must_fail git config test.nine &&
+ git checkout -b foo-branch &&
+ echo 9 >expect &&
+ git config test.nine >actual &&
+ test_cmp expect actual
+'
+
+test_expect_success 'conditional include, onbranch, wildcard' '
+ echo "[includeIf \"onbranch:?oo-*/**\"]path=bar10" >>.git/config &&
+ echo "[test]ten=10" >.git/bar10 &&
+ git checkout -b not-foo-branch/a &&
+ test_must_fail git config test.ten &&
+
+ echo 10 >expect &&
+ git checkout -b foo-branch/a/b/c &&
+ git config test.ten >actual &&
+ test_cmp expect actual &&
+
+ git checkout -b moo-bar/a &&
+ git config test.ten >actual &&
+ test_cmp expect actual
+'
+
+test_expect_success 'conditional include, onbranch, implicit /** for /' '
+ echo "[includeIf \"onbranch:foo-dir/\"]path=bar11" >>.git/config &&
+ echo "[test]eleven=11" >.git/bar11 &&
+ git checkout -b not-foo-dir/a &&
+ test_must_fail git config test.eleven &&
+
+ echo 11 >expect &&
+ git checkout -b foo-dir/a/b/c &&
+ git config test.eleven >actual &&
+ test_cmp expect actual
+'
+
test_expect_success 'include cycles are detected' '
cat >.gitconfig <<-\EOF &&
[test]value = gitconfig
--
2.22.0.rc1.169.g49223abbf8
next prev parent reply other threads:[~2019-06-05 21:22 UTC|newest]
Thread overview: 59+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-05-05 16:24 [PATCH 0/7] teach branch-specific options for format-patch Denton Liu
2019-05-05 16:24 ` [PATCH 1/7] t4014: clean up style Denton Liu
2019-05-05 16:24 ` [PATCH 2/7] Doc: add more detail for git-format-patch Denton Liu
2019-05-05 16:24 ` [PATCH 3/7] branch.c: extract read_branch_config function Denton Liu
2019-05-05 16:24 ` [PATCH 4/7] format-patch: make cover letter subject configurable Denton Liu
2019-05-05 16:24 ` [PATCH 5/7] format-patch: move extra_headers logic later Denton Liu
2019-05-05 16:24 ` [PATCH 6/7] string-list: create string_list_append_all Denton Liu
2019-05-05 16:24 ` [PATCH 7/7] format-patch: read branch-specific To: and Cc: headers Denton Liu
2019-05-07 8:56 ` [PATCH 0/7] teach branch-specific options for format-patch Junio C Hamano
2019-05-07 14:19 ` Denton Liu
2019-05-07 15:05 ` Junio C Hamano
2019-05-07 15:21 ` Denton Liu
2019-05-07 15:46 ` Ævar Arnfjörð Bjarmason
2019-05-08 1:45 ` Junio C Hamano
2019-05-31 2:00 ` [RFC PATCH] config: learn the "onbranch:" includeIf condition Denton Liu
2019-05-31 12:58 ` Johannes Schindelin
2019-05-31 13:16 ` Denton Liu
2019-05-31 17:23 ` Johannes Schindelin
2019-05-31 18:44 ` Denton Liu
2019-05-31 19:33 ` [PATCH v2] " Denton Liu
2019-05-31 20:14 ` Johannes Schindelin
2019-06-05 8:02 ` Johannes Schindelin
2019-06-05 10:08 ` Duy Nguyen
2019-06-05 21:21 ` Denton Liu [this message]
2019-06-06 12:52 ` [PATCH v3] " Johannes Schindelin
2019-05-17 0:27 ` [PATCH v2 0/6] teach branch-specific options for format-patch Denton Liu
2019-05-17 0:27 ` [PATCH v2 1/6] t4014: clean up style Denton Liu
2019-05-17 0:27 ` [PATCH v2 2/6] Doc: add more detail for git-format-patch Denton Liu
2019-05-17 0:27 ` [PATCH v2 3/6] format-patch: make cover letter subject configurable Denton Liu
2019-05-17 0:27 ` [PATCH v2 4/6] format-patch: move extra_headers logic later Denton Liu
2019-05-17 0:27 ` [PATCH v2 5/6] string-list: create string_list_append_all Denton Liu
2019-05-17 0:27 ` [PATCH v2 6/6] format-patch: read branch-specific To: and Cc: headers Denton Liu
2019-05-17 4:12 ` [PATCH v2 0/6] teach branch-specific options for format-patch Junio C Hamano
2019-05-17 7:25 ` Denton Liu
2019-05-17 16:54 ` Denton Liu
2019-05-22 2:44 ` [PATCH v3 0/8] " Denton Liu
2019-05-22 2:44 ` [PATCH v3 1/8] t4014: clean up style Denton Liu
2019-05-22 2:44 ` [PATCH v3 2/8] Doc: add more detail for git-format-patch Denton Liu
2019-05-22 2:44 ` [PATCH v3 3/8] format-patch: infer cover letter from branch description Denton Liu
2019-05-22 2:44 ` [PATCH v3 4/8] format-patch: move extra_headers logic later Denton Liu
2019-05-22 2:44 ` [PATCH v3 5/8] string-list: create string_list_append_all Denton Liu
2019-05-22 2:44 ` [PATCH v3 6/8] format-patch: read branch-specific To: and Cc: headers Denton Liu
2019-05-22 2:44 ` [PATCH v3 7/8] format-patch: move output_directory logic later Denton Liu
2019-05-22 2:44 ` [PATCH v3 8/8] format-patch: read branch-specific output directory Denton Liu
2019-05-31 0:30 ` [PATCH v3 0/8] teach branch-specific options for format-patch Denton Liu
2019-06-14 21:56 ` [RESEND PATCH " Denton Liu
2019-06-14 21:56 ` [RESEND PATCH v3 1/8] t4014: clean up style Denton Liu
2019-06-14 21:56 ` [RESEND PATCH v3 2/8] Doc: add more detail for git-format-patch Denton Liu
2019-06-14 21:56 ` [RESEND PATCH v3 3/8] format-patch: infer cover letter from branch description Denton Liu
2019-06-14 21:56 ` [RESEND PATCH v3 4/8] format-patch: move extra_headers logic later Denton Liu
2019-06-14 21:56 ` [RESEND PATCH v3 5/8] string-list: create string_list_append_all Denton Liu
2019-06-14 21:56 ` [RESEND PATCH v3 6/8] format-patch: read branch-specific To: and Cc: headers Denton Liu
2019-06-14 21:56 ` [RESEND PATCH v3 7/8] format-patch: move output_directory logic later Denton Liu
2019-06-14 21:56 ` [RESEND PATCH v3 8/8] format-patch: read branch-specific output directory Denton Liu
2019-10-15 9:06 ` [PATCH v6 0/3] format-patch: learn --infer-cover-subject option (also t4014 cleanup) Denton Liu
2019-10-15 9:06 ` [PATCH v6 1/3] format-patch: replace erroneous and condition Denton Liu
2019-10-15 9:06 ` [PATCH v6 2/3] format-patch: use enum variables Denton Liu
2019-10-15 9:06 ` [PATCH v6 3/3] format-patch: teach --cover-from-description option Denton Liu
2019-10-16 1:28 ` [PATCH v6 0/3] format-patch: learn --infer-cover-subject option (also t4014 cleanup) Junio C Hamano
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=49e22269d5a66d1975fca71a300e9099f46e1c40.1559769658.git.liu.denton@gmail.com \
--to=liu.denton@gmail.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=pclouds@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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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).