[PATCHv2 6/8] var: provide explicit/implicit ident information
- From
Jeff King <peff@peff.net>
- Date
- Nov 15, 2012, 00:35 UTC
- Message-ID
- <20121115003550.GF17819@sigill.intra.peff.net>
- In-Reply-To
- <20121115003029.GA17550@sigill.intra.peff.net>
Internally, we keep track of whether the author or committer ident information was provided by the user, or whether it was implicitly determined by the system. However, there is currently no way for external programs or scripts to get this information without re-implementing the ident logic themselves. Let's provide a way for them to do so.
Signed-off-by: Jeff King <peff@peff.net> --- Documentation/git-var.txt | 12 ++++++++++++ builtin/var.c | 27 +++++++++++++++++++++++++++ t/t0007-git-var.sh | 36 ++++++++++++++++++++++++++++++++++++ 3 files changed, 75 insertions(+)
diff --git a/Documentation/git-var.txt b/Documentation/git-var.txt index 53abba5..bb2997d 100644 --- a/Documentation/git-var.txt +++ b/Documentation/git-var.txt @@ -39,9 +39,21 @@ VARIABLES GIT_AUTHOR_IDENT:: The author of a piece of code. +GIT_AUTHOR_EXPLICIT:: + Outputs "1" if the author identity was provided explicitly by the + user, or "0" if it was determined implicitly from the system. + Identity is considered explicit if it comes from one of git's config + file (i.e., via the `user.*` variables), from the `$GIT_AUTHOR_*` + environment variables, or from the `$EMAIL` environment variable. It + is considered implicit if it was generated from system variables + like the username and hostname. + GIT_COMMITTER_IDENT:: The person who put a piece of code into git. +GIT_COMMITTER_EXPLICIT:: + Like GIT_AUTHOR_EXPLICIT, but for the committer ident. + GIT_EDITOR:: Text editor for use by git commands. The value is meant to be interpreted by the shell when it is used. Examples: `~/bin/vi`, diff --git a/builtin/var.c b/builtin/var.c index 49ab300..9503df9 100644 --- a/builtin/var.c +++ b/builtin/var.c @@ -26,13 +26,40 @@ static const char *pager(int flag) return pgm; } +static const char *explicit_ident(const char * (*get_ident)(int), + int (*check_ident)(void)) +{ + /* + * Prime the "explicit" flag by getting the identity. + * We do not want to be strict here, because we would not want + * to die on bogus implicit values, but instead just report that they + * are not explicit. + */ + get_ident(0); + return check_ident() ? "1" : "0"; +} + +static const char *committer_explicit(int flag) +{ + return explicit_ident(git_committer_info, + committer_ident_sufficiently_given); +} + +static const char *author_explicit(int flag) +{ + return explicit_ident(git_author_info, + author_ident_sufficiently_given); +} + struct git_var { const char *name; const char *(*read)(int); }; static struct git_var git_vars[] = { { "GIT_COMMITTER_IDENT", git_committer_info }, + { "GIT_COMMITTER_EXPLICIT", committer_explicit }, { "GIT_AUTHOR_IDENT", git_author_info }, + { "GIT_AUTHOR_EXPLICIT", author_explicit }, { "GIT_EDITOR", editor }, { "GIT_PAGER", pager }, { "", NULL }, diff --git a/t/t0007-git-var.sh b/t/t0007-git-var.sh index ec5d946..47907de 100755 --- a/t/t0007-git-var.sh +++ b/t/t0007-git-var.sh @@ -47,4 +47,40 @@ test_expect_success 'git var can show multiple values' ' test_cmp expect actual ' +for type in AUTHOR COMMITTER; do + test_expect_success "$type ident can detect implicit values" " + echo 0 >expect && + ( + sane_unset GIT_${type}_NAME && + sane_unset GIT_${type}_EMAIL && + sane_unset EMAIL && + git var GIT_${type}_EXPLICIT >actual + ) && + test_cmp expect actual + " + + test_expect_success "$type ident is explicit via environment" " + echo 1 >expect && + ( + GIT_${type}_NAME='A Name' && + export GIT_${type}_NAME && + GIT_${type}_EMAIL='name@example.com' && + export GIT_${type}_EMAIL && + git var GIT_${type}_EXPLICIT >actual + ) && + test_cmp expect actual + " + + test_expect_success "$type ident is explicit via config" " + echo 1 >expect && + test_config user.name 'A Name' && + test_config user.email 'name@example.com' && + ( + sane_unset GIT_${type}_NAME && + sane_unset GIT_${type}_EMAIL && + git var GIT_${type}_EXPLICIT >actual + ) + " +done + test_done
-- 1.8.0.207.gdf2154c