[PATCH v2 0/7] Additional variables for git var
- From
brian m. carlson <sandals@crustytoothpaste.net>
- Date
- Jun 26, 2023, 19:00 UTC
- Message-ID
- <20230626190008.644769-1-sandals@crustytoothpaste.net>
- In-Reply-To
- <20230622195059.320593-1-sandals@crustytoothpaste.net>
On many Unix systems, we have a good idea where Git's configuration files and the shell it uses are located. However, there are some systems where that's not the case, such as Windows and with Homebrew, where the expected files might be found in another location.
Right now, programs who would like to access things like the system gitattributes or config file have to guess where the distributor of Git placed these files, and with runtime relocation, it's not even guaranteed that these will be in a fixed place from invocation to invocation. As a result, we need a way to query Git about the location of these files.
This series introduces five new configuration variables that refer to the shell path, the system and global gitattributes files, and the system and global config files. The global values are not technically needed, since they should be computable from the environment alone, but they are added to make life easier for users.
I have adopted most of the changes suggested, but I have specifically not adopted the use of `.` in our tests instead of `$(pwd)`. That breaks the tests on Windows, the functionality of which has already been the major portion of the time spent on this series despite careful forethought about functionality there, and as a non-Windows user, I'm simply not capable of or interested in futzing around with it more. Parties who are unhappy with that are invited to send a follow-up patch after this series lands.
Changes since v1: * Format variables with C99 initializers. * Minimize use of temporary files in the tests. * Remove debugging statement. * Avoid grep where possible in tests. * Duplicate memory rather than optionally choosing whether to free data. * Add and document test_file_is_executable. * Possibly more things which I have forgotten.
brian m. carlson (7): t: add a function to check executable bit var: add support for listing the shell var: format variable structure with C99 initializers var: adjust memory allocation for strings attr: expose and rename accessor functions var: add attributes files locations var: add config file locations
Documentation/git-var.txt | 23 +++++ attr.c | 14 +-- attr.h | 9 ++ builtin/var.c | 178 +++++++++++++++++++++++++++++++++----- t/README | 6 ++ t/t0007-git-var.sh | 100 +++++++++++++++++++++ t/test-lib-functions.sh | 9 ++ 7 files changed, 312 insertions(+), 27 deletions(-)
Range-diff against v1:
-: ---------- > 1: 20b7b85e98 t: add a function to check executable bit
1: 441dc45a86 ! 2: 7d92b4155f var: add support for listing the shell
@@ t/t0007-git-var.sh: test_expect_success 'get GIT_SEQUENCE_EDITOR with configurat
'
+test_expect_success POSIXPERM 'GIT_SHELL_PATH points to a valid executable' '
-+ git var GIT_SHELL_PATH >shell &&
-+ test -x "$(cat shell)"
++ shellpath=$(git var GIT_SHELL_PATH) &&
++ test_path_is_executable "$shellpath"
+'
+
+# We know in this environment that our shell will be one of a few fixed values
+# that all end in "sh".
+test_expect_success MINGW 'GIT_SHELL_PATH points to a suitable shell' '
-+ git var GIT_SHELL_PATH >shell &&
-+ grep "sh\$" shell
++ shellpath=$(git var GIT_SHELL_PATH) &&
++ case "$shellpath" in
++ *sh) ;;
++ *) return 1;;
++ esac
+'
+
# For git var -l, we check only a representative variable;
2: 3b6935f226 < -: ---------- var: add attributes files locations
-: ---------- > 3: 29c338d59c var: format variable structure with C99 initializers
-: ---------- > 4: 2a2a762c44 var: adjust memory allocation for strings
-: ---------- > 5: c0c5c59df9 attr: expose and rename accessor functions
-: ---------- > 6: 49a04bd142 var: add attributes files locations
3: 6a2b5494dd ! 7: a8b4d9396b var: add config file locations
@@ Documentation/git-var.txt: GIT_ATTR_SYSTEM::
linkgit:git-commit-tree[1]
## builtin/var.c ##
-@@ builtin/var.c: static const char *git_attr_val_global(int flag)
+@@ builtin/var.c: static char *git_attr_val_global(int flag)
return NULL;
}
-+static const char *git_config_val_system(int flag)
++static char *git_config_val_system(int flag)
+{
+ if (git_config_system()) {
+ char *file = git_system_config();
@@ builtin/var.c: static const char *git_attr_val_global(int flag)
+ return NULL;
+}
+
-+static const char *git_config_val_global(int flag)
++static char *git_config_val_global(int flag)
+{
+ struct strbuf buf = STRBUF_INIT;
+ char *user, *xdg;
@@ builtin/var.c: static const char *git_attr_val_global(int flag)
+
struct git_var {
const char *name;
- const char *(*read)(int);
+ char *(*read)(int);
+ int multivalued;
- int free;
};
static struct git_var git_vars[] = {
-- { "GIT_COMMITTER_IDENT", git_committer_info, 0 },
-- { "GIT_AUTHOR_IDENT", git_author_info, 0 },
-- { "GIT_EDITOR", editor, 0 },
-- { "GIT_SEQUENCE_EDITOR", sequence_editor, 0 },
-- { "GIT_PAGER", pager, 0 },
-- { "GIT_DEFAULT_BRANCH", default_branch, 0 },
-- { "GIT_SHELL_PATH", shell_path, 0 },
-- { "GIT_ATTR_SYSTEM", git_attr_val_system, 1 },
-- { "GIT_ATTR_GLOBAL", git_attr_val_global, 1 },
-+ { "GIT_COMMITTER_IDENT", git_committer_info, 0, 0 },
-+ { "GIT_AUTHOR_IDENT", git_author_info, 0, 0 },
-+ { "GIT_EDITOR", editor, 0, 0 },
-+ { "GIT_SEQUENCE_EDITOR", sequence_editor, 0, 0 },
-+ { "GIT_PAGER", pager, 0, 0 },
-+ { "GIT_DEFAULT_BRANCH", default_branch, 0, 9 },
-+ { "GIT_SHELL_PATH", shell_path, 0, 0 },
-+ { "GIT_ATTR_SYSTEM", git_attr_val_system, 0, 1 },
-+ { "GIT_ATTR_GLOBAL", git_attr_val_global, 0, 1 },
-+ { "GIT_CONFIG_SYSTEM", git_config_val_system, 0, 1 },
-+ { "GIT_CONFIG_GLOBAL", git_config_val_global, 1, 1 },
- { "", NULL },
+ {
+ .name = "GIT_COMMITTER_IDENT",
+ .read = committer,
++ .multivalued = 0,
+ },
+ {
+ .name = "GIT_AUTHOR_IDENT",
+ .read = author,
++ .multivalued = 0,
+ },
+ {
+ .name = "GIT_EDITOR",
+ .read = editor,
++ .multivalued = 0,
+ },
+ {
+ .name = "GIT_SEQUENCE_EDITOR",
+ .read = sequence_editor,
++ .multivalued = 0,
+ },
+ {
+ .name = "GIT_PAGER",
+ .read = pager,
++ .multivalued = 0,
+ },
+ {
+ .name = "GIT_DEFAULT_BRANCH",
+ .read = default_branch,
++ .multivalued = 0,
+ },
+ {
+ .name = "GIT_SHELL_PATH",
+ .read = shell_path,
++ .multivalued = 0,
+ },
+ {
+ .name = "GIT_ATTR_SYSTEM",
+ .read = git_attr_val_system,
++ .multivalued = 0,
+ },
+ {
+ .name = "GIT_ATTR_GLOBAL",
+ .read = git_attr_val_global,
++ .multivalued = 0,
++ },
++ {
++ .name = "GIT_CONFIG_SYSTEM",
++ .read = git_config_val_system,
++ .multivalued = 0,
++ },
++ {
++ .name = "GIT_CONFIG_GLOBAL",
++ .read = git_config_val_global,
++ .multivalued = 1,
+ },
+ {
+ .name = "",
+ .read = NULL,
++ .multivalued = 0,
+ },
};
@@ builtin/var.c: static void list_vars(void)
@@ builtin/var.c: static void list_vars(void)
+ } else {
+ printf("%s=%s\n", ptr->name, val);
+ }
- if (ptr->free)
- free((void *)val);
+ free(val);
}
+ }
## t/t0007-git-var.sh ##
@@ t/t0007-git-var.sh: test_expect_success 'GIT_ATTR_GLOBAL points to the correct location' '
@@ t/t0007-git-var.sh: test_expect_success 'GIT_ATTR_GLOBAL points to the correct l
+ test_must_fail env GIT_CONFIG_NOSYSTEM=1 git var GIT_CONFIG_SYSTEM &&
+ (
+ sane_unset GIT_CONFIG_NOSYSTEM &&
-+ git var GIT_CONFIG_SYSTEM >path &&
-+ test "$(cat path)" != "" &&
-+ GIT_CONFIG_SYSTEM=/dev/null git var GIT_CONFIG_SYSTEM >path &&
++ systempath=$(git var GIT_CONFIG_SYSTEM) &&
++ test "$systempath" != "" &&
++ systempath=$(GIT_CONFIG_SYSTEM=/dev/null git var GIT_CONFIG_SYSTEM) &&
+ if test_have_prereq MINGW
+ then
-+ test "$(cat path)" = "nul"
++ test "$systempath" = "nul"
+ else
-+ test "$(cat path)" = "/dev/null"
++ test "$systempath" = "/dev/null"
+ fi &&
-+ GIT_CONFIG_SYSTEM="$TRASHDIR/gitconfig" git var GIT_CONFIG_SYSTEM >path &&
-+ test "$(cat path)" = "$TRASHDIR/gitconfig"
++ systempath=$(GIT_CONFIG_SYSTEM="$TRASHDIR/gitconfig" git var GIT_CONFIG_SYSTEM) &&
++ test "$systempath" = "$TRASHDIR/gitconfig"
+ )
+'
+
@@ t/t0007-git-var.sh: test_expect_success 'GIT_ATTR_GLOBAL points to the correct l
+ echo "$TRASHDIR/.config/git/config" >expected &&
+ echo "$TRASHDIR/.gitconfig" >>expected &&
+ test_cmp expected actual &&
-+ GIT_CONFIG_GLOBAL=/dev/null git var GIT_CONFIG_GLOBAL >path &&
++ globalpath=$(GIT_CONFIG_GLOBAL=/dev/null git var GIT_CONFIG_GLOBAL) &&
+ if test_have_prereq MINGW
+ then
-+ test "$(cat path)" = "nul"
++ test "$globalpath" = "nul"
+ else
-+ test "$(cat path)" = "/dev/null"
++ test "$globalpath" = "/dev/null"
+ fi &&
-+ GIT_CONFIG_GLOBAL="$TRASHDIR/gitconfig" git var GIT_CONFIG_GLOBAL >path &&
-+ test "$(cat path)" = "$TRASHDIR/gitconfig"
++ globalpath=$(GIT_CONFIG_GLOBAL="$TRASHDIR/gitconfig" git var GIT_CONFIG_GLOBAL) &&
++ test "$globalpath" = "$TRASHDIR/gitconfig"
+ )
+'
+
@@ t/t0007-git-var.sh: test_expect_success 'git var -l lists config' '
+ export GIT_EDITOR &&
+ echo "GIT_EDITOR=$GIT_EDITOR" >expected &&
+ git var -l >var &&
-+ cat var &&
+ sed -n -e "/^GIT_EDITOR/,\$p" var | head -n 3 >actual &&
+ test_cmp expected actual
+ )