* [PATCH 1/2] tag: use skip_prefix instead of magic numbers @ 2014-07-10 23:52 Jacob Keller 2014-07-10 23:52 ` [PATCH 2/2 v4] tag: support configuring --sort via .gitconfig Jacob Keller 0 siblings, 1 reply; 10+ messages in thread From: Jacob Keller @ 2014-07-10 23:52 UTC (permalink / raw) To: git; +Cc: Jacob Keller Make the parsing of the --sort parameter more readable by having skip_prefix keep our pointer up to date. Authored-by: Jeff King <peff@peff.net> Signed-off-by: Jacob Keller <jacob.e.keller@intel.com> --- builtin/tag.c | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/builtin/tag.c b/builtin/tag.c index ef765563388c..7ccb6f3c581b 100644 --- a/builtin/tag.c +++ b/builtin/tag.c @@ -524,18 +524,12 @@ static int parse_opt_sort(const struct option *opt, const char *arg, int unset) int *sort = opt->value; int flags = 0; - if (*arg == '-') { + if (skip_prefix(arg, "-", &arg)) flags |= REVERSE_SORT; - arg++; - } - if (starts_with(arg, "version:")) { + + if (skip_prefix(arg, "version:", &arg) || skip_prefix(arg, "v:", &arg)) *sort = VERCMP_SORT; - arg += 8; - } else if (starts_with(arg, "v:")) { - *sort = VERCMP_SORT; - arg += 2; - } else - *sort = STRCMP_SORT; + if (strcmp(arg, "refname")) die(_("unsupported sort specification %s"), arg); *sort |= flags; -- 2.0.1.475.g9b8d714 ^ permalink raw reply related [flat|nested] 10+ messages in thread
* [PATCH 2/2 v4] tag: support configuring --sort via .gitconfig 2014-07-10 23:52 [PATCH 1/2] tag: use skip_prefix instead of magic numbers Jacob Keller @ 2014-07-10 23:52 ` Jacob Keller 2014-07-11 15:04 ` Junio C Hamano 2014-07-16 0:55 ` Duy Nguyen 0 siblings, 2 replies; 10+ messages in thread From: Jacob Keller @ 2014-07-10 23:52 UTC (permalink / raw) To: git; +Cc: Jacob Keller, Jeff King Add support for configuring default sort ordering for git tags. Command line option will override this configured value, using the exact same syntax. Cc: Jeff King <peff@peff.net> Signed-off-by: Jacob Keller <jacob.e.keller@intel.com> --- - v4 * base on top of suggested change by Jeff King to use skip_prefix instead Documentation/config.txt | 6 ++++++ Documentation/git-tag.txt | 1 + builtin/tag.c | 46 ++++++++++++++++++++++++++++++++-------------- t/t7004-tag.sh | 21 +++++++++++++++++++++ 4 files changed, 60 insertions(+), 14 deletions(-) diff --git a/Documentation/config.txt b/Documentation/config.txt index 1d718bdb9662..ad8e75fed988 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -2354,6 +2354,12 @@ submodule.<name>.ignore:: "--ignore-submodules" option. The 'git submodule' commands are not affected by this setting. +tag.sort:: + This variable is used to control the sort ordering of tags. It is + interpreted precisely the same way as "--sort=<value>". If --sort is + given on the command line it will override the selection chosen in the + configuration. See linkgit:git-tag[1] for more details. + tar.umask:: This variable can be used to restrict the permission bits of tar archive entries. The default is 0002, which turns off the diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt index b424a1bc48bb..2d246725aeb5 100644 --- a/Documentation/git-tag.txt +++ b/Documentation/git-tag.txt @@ -317,6 +317,7 @@ include::date-formats.txt[] SEE ALSO -------- linkgit:git-check-ref-format[1]. +linkgit:git-config[1]. GIT --- diff --git a/builtin/tag.c b/builtin/tag.c index 7ccb6f3c581b..a53e27d4e7e4 100644 --- a/builtin/tag.c +++ b/builtin/tag.c @@ -18,6 +18,8 @@ #include "sha1-array.h" #include "column.h" +static int tag_sort = 0; + static const char * const git_tag_usage[] = { N_("git tag [-a|-s|-u <key-id>] [-f] [-m <msg>|-F <file>] <tagname> [<head>]"), N_("git tag -d <tagname>..."), @@ -346,9 +348,33 @@ static const char tag_template_nocleanup[] = "Lines starting with '%c' will be kept; you may remove them" " yourself if you want to.\n"); +static int parse_sort_string(const char *arg) +{ + int sort = 0; + int flags = 0; + + if (skip_prefix(arg, "-", &arg)) + flags |= REVERSE_SORT; + + if (skip_prefix(arg, "version:", &arg) || skip_prefix(arg, "v:", &arg)) + sort = VERCMP_SORT; + + if (strcmp(arg, "refname")) + die(_("unsupported sort specification %s"), arg); + sort |= flags; + + return sort; +} + static int git_tag_config(const char *var, const char *value, void *cb) { - int status = git_gpg_config(var, value, cb); + int status; + + if (!strcmp(var, "tag.sort")) { + tag_sort = parse_sort_string(value); + } + + status = git_gpg_config(var, value, cb); if (status) return status; if (starts_with(var, "column.")) @@ -522,17 +548,9 @@ static int parse_opt_points_at(const struct option *opt __attribute__((unused)), static int parse_opt_sort(const struct option *opt, const char *arg, int unset) { int *sort = opt->value; - int flags = 0; - if (skip_prefix(arg, "-", &arg)) - flags |= REVERSE_SORT; + *sort = parse_sort_string(arg); - if (skip_prefix(arg, "version:", &arg) || skip_prefix(arg, "v:", &arg)) - *sort = VERCMP_SORT; - - if (strcmp(arg, "refname")) - die(_("unsupported sort specification %s"), arg); - *sort |= flags; return 0; } @@ -546,7 +564,7 @@ int cmd_tag(int argc, const char **argv, const char *prefix) struct create_tag_options opt; char *cleanup_arg = NULL; int annotate = 0, force = 0, lines = -1; - int cmdmode = 0, sort = 0; + int cmdmode = 0; const char *msgfile = NULL, *keyid = NULL; struct msg_arg msg = { 0, STRBUF_INIT }; struct commit_list *with_commit = NULL; @@ -572,7 +590,7 @@ int cmd_tag(int argc, const char **argv, const char *prefix) OPT__FORCE(&force, N_("replace the tag if exists")), OPT_COLUMN(0, "column", &colopts, N_("show tag list in columns")), { - OPTION_CALLBACK, 0, "sort", &sort, N_("type"), N_("sort tags"), + OPTION_CALLBACK, 0, "sort", &tag_sort, N_("type"), N_("sort tags"), PARSE_OPT_NONEG, parse_opt_sort }, @@ -628,9 +646,9 @@ int cmd_tag(int argc, const char **argv, const char *prefix) copts.padding = 2; run_column_filter(colopts, &copts); } - if (lines != -1 && sort) + if (lines != -1 && tag_sort) die(_("--sort and -n are incompatible")); - ret = list_tags(argv, lines == -1 ? 0 : lines, with_commit, sort); + ret = list_tags(argv, lines == -1 ? 0 : lines, with_commit, tag_sort); if (column_active(colopts)) stop_column_filter(); return ret; diff --git a/t/t7004-tag.sh b/t/t7004-tag.sh index e4ab0f5b6419..1e8300f6ed7c 100755 --- a/t/t7004-tag.sh +++ b/t/t7004-tag.sh @@ -1423,6 +1423,27 @@ EOF test_cmp expect actual ' +test_expect_success 'configured lexical sort' ' + git config tag.sort "v:refname" && + git tag -l "foo*" >actual && + cat >expect <<EOF && +foo1.3 +foo1.6 +foo1.10 +EOF + test_cmp expect actual +' + +test_expect_success 'option override configured sort' ' + git tag -l --sort=-refname "foo*" >actual && + cat >expect <<EOF && +foo1.6 +foo1.3 +foo1.10 +EOF + test_cmp expect actual +' + run_with_limited_stack () { (ulimit -s 64 && "$@") } -- 2.0.1.475.g9b8d714 ^ permalink raw reply related [flat|nested] 10+ messages in thread
* Re: [PATCH 2/2 v4] tag: support configuring --sort via .gitconfig 2014-07-10 23:52 ` [PATCH 2/2 v4] tag: support configuring --sort via .gitconfig Jacob Keller @ 2014-07-11 15:04 ` Junio C Hamano 2014-07-11 16:20 ` Keller, Jacob E ` (2 more replies) 2014-07-16 0:55 ` Duy Nguyen 1 sibling, 3 replies; 10+ messages in thread From: Junio C Hamano @ 2014-07-11 15:04 UTC (permalink / raw) To: Jacob Keller; +Cc: git, Jeff King Jacob Keller <jacob.e.keller@intel.com> writes: > Add support for configuring default sort ordering for git tags. Command > line option will override this configured value, using the exact same > syntax. > > Cc: Jeff King <peff@peff.net> > Signed-off-by: Jacob Keller <jacob.e.keller@intel.com> > --- > - v4 > * base on top of suggested change by Jeff King to use skip_prefix instead > > Documentation/config.txt | 6 ++++++ > Documentation/git-tag.txt | 1 + > builtin/tag.c | 46 ++++++++++++++++++++++++++++++++-------------- > t/t7004-tag.sh | 21 +++++++++++++++++++++ > 4 files changed, 60 insertions(+), 14 deletions(-) > > diff --git a/Documentation/config.txt b/Documentation/config.txt > index 1d718bdb9662..ad8e75fed988 100644 > --- a/Documentation/config.txt > +++ b/Documentation/config.txt > @@ -2354,6 +2354,12 @@ submodule.<name>.ignore:: > "--ignore-submodules" option. The 'git submodule' commands are not > affected by this setting. > > +tag.sort:: > + This variable is used to control the sort ordering of tags. It is > + interpreted precisely the same way as "--sort=<value>". If --sort is > + given on the command line it will override the selection chosen in the > + configuration. See linkgit:git-tag[1] for more details. > + This is not technically incorrect per-se, but the third sentence talks about "--sort" on "the command line" while this applies only to "the command line of the 'git tag' command" and nobody else's "--sort" option. Perhaps rephrasing it like this may be easier to understand? When "git tag" command is used to list existing tags, without "--sort=<value>" option on the command line, the value of this variable is used as the default. This way, it would be clear, without explicitly saying anything, that the value will be spelled exactly the same way as you would spell the value for the --sort option on the command line. > diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt > index b424a1bc48bb..2d246725aeb5 100644 > --- a/Documentation/git-tag.txt > +++ b/Documentation/git-tag.txt > @@ -317,6 +317,7 @@ include::date-formats.txt[] > SEE ALSO > -------- > linkgit:git-check-ref-format[1]. > +linkgit:git-config[1]. It is not particularly friendly to readers to refer to "git-config[1]" from any other page, if done without spelling out which variable the reader is expected to look up. Some addition to the description of the "--sort" option is needed if this SEE ALSO were to be any useful, I guess? --sort=<type>:: ... (existing description) ... When this option is not given, the sort order defaults to the value configured for the `tag.sort` variable, if exists, or lexicographic otherwise. or something like that, perhaps? > diff --git a/builtin/tag.c b/builtin/tag.c > index 7ccb6f3c581b..a53e27d4e7e4 100644 > --- a/builtin/tag.c > +++ b/builtin/tag.c > @@ -18,6 +18,8 @@ > #include "sha1-array.h" > #include "column.h" > > +static int tag_sort = 0; Please do not initialize variables in bss segment to 0 by hand. If this variable is meant to take one of these *CMP_SORT values defined as macro later in this file, it is better to define this variable somewhere after and close to the definitions of the macros. Perhaps immediately after the "struct tag_filter" is declared? > @@ -346,9 +348,33 @@ static const char tag_template_nocleanup[] = > "Lines starting with '%c' will be kept; you may remove them" > " yourself if you want to.\n"); > > +static int parse_sort_string(const char *arg) > +{ > + int sort = 0; > + int flags = 0; > + > + if (skip_prefix(arg, "-", &arg)) > + flags |= REVERSE_SORT; > + > + if (skip_prefix(arg, "version:", &arg) || skip_prefix(arg, "v:", &arg)) > + sort = VERCMP_SORT; > + > + if (strcmp(arg, "refname")) > + die(_("unsupported sort specification %s"), arg); Hmm. I _thought_ we try to catch unsupported option value coming from the command line and die but at the same time we try *not* to die but warn and whatever is sensible when the value comes from the configuration, so that .git/config or $HOME/.gitconfig can be shared by those who use different versions of Git. Do we already have many precedences where we see configuration value that our version of Git do not yet understand? Not a very strong objection; just something that worries me. > + sort |= flags; > + > + return sort; > +} > + > static int git_tag_config(const char *var, const char *value, void *cb) > { > - int status = git_gpg_config(var, value, cb); > + int status; > + > + if (!strcmp(var, "tag.sort")) { > + tag_sort = parse_sort_string(value); > + } > + Why doesn't this return success after noticing that the variable is to be interpreted by this block and nobody else? When there is no reason to have things in a particular order, it is customary to add new things at the end, not in the front, unless the new thing is so much more important than everything else---but then we are no longer talking about the case where there is no reason to have things in a particular order ;-). Remainder of the changes to builtin/tag.c looks good. > diff --git a/t/t7004-tag.sh b/t/t7004-tag.sh > index e4ab0f5b6419..1e8300f6ed7c 100755 > --- a/t/t7004-tag.sh > +++ b/t/t7004-tag.sh > @@ -1423,6 +1423,27 @@ EOF > test_cmp expect actual > ' > > +test_expect_success 'configured lexical sort' ' > + git config tag.sort "v:refname" && > + git tag -l "foo*" >actual && > + cat >expect <<EOF && > +foo1.3 > +foo1.6 > +foo1.10 > +EOF > + test_cmp expect actual > +' Please write the above like so: ... cat >expect <<-\EOF && foo1.3 ... EOF test_cmp expect actual The dash immediately after the here-doc redirection lets us indent the data with HT to allow the test boundaries easier to spot, and by quoting the token to end here-doc, we relieve the readers from having to wonder if there are variable substitutions going on that they need to be careful about. Overall, I think this is done well. Thanks for working on it. ^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH 2/2 v4] tag: support configuring --sort via .gitconfig 2014-07-11 15:04 ` Junio C Hamano @ 2014-07-11 16:20 ` Keller, Jacob E 2014-07-11 16:28 ` Junio C Hamano 2014-07-11 16:40 ` Keller, Jacob E 2014-07-11 17:20 ` Keller, Jacob E 2 siblings, 1 reply; 10+ messages in thread From: Keller, Jacob E @ 2014-07-11 16:20 UTC (permalink / raw) To: gitster@pobox.com; +Cc: git@vger.kernel.org, peff@peff.net On Fri, 2014-07-11 at 08:04 -0700, Junio C Hamano wrote: > Jacob Keller <jacob.e.keller@intel.com> writes: > > > Add support for configuring default sort ordering for git tags. Command > > line option will override this configured value, using the exact same > > syntax. > > > > Cc: Jeff King <peff@peff.net> > > Signed-off-by: Jacob Keller <jacob.e.keller@intel.com> > > --- > > - v4 > > * base on top of suggested change by Jeff King to use skip_prefix instead > > > > Documentation/config.txt | 6 ++++++ > > Documentation/git-tag.txt | 1 + > > builtin/tag.c | 46 ++++++++++++++++++++++++++++++++-------------- > > t/t7004-tag.sh | 21 +++++++++++++++++++++ > > 4 files changed, 60 insertions(+), 14 deletions(-) > > > > diff --git a/Documentation/config.txt b/Documentation/config.txt > > index 1d718bdb9662..ad8e75fed988 100644 > > --- a/Documentation/config.txt > > +++ b/Documentation/config.txt > > @@ -2354,6 +2354,12 @@ submodule.<name>.ignore:: > > "--ignore-submodules" option. The 'git submodule' commands are not > > affected by this setting. > > > > +tag.sort:: > > + This variable is used to control the sort ordering of tags. It is > > + interpreted precisely the same way as "--sort=<value>". If --sort is > > + given on the command line it will override the selection chosen in the > > + configuration. See linkgit:git-tag[1] for more details. > > + > > This is not technically incorrect per-se, but the third sentence > talks about "--sort" on "the command line" while this applies only > to "the command line of the 'git tag' command" and nobody else's > "--sort" option. > > Perhaps rephrasing it like this may be easier to understand? > > When "git tag" command is used to list existing tags, > without "--sort=<value>" option on the command line, > the value of this variable is used as the default. > > This way, it would be clear, without explicitly saying anything, > that the value will be spelled exactly the same way as you would > spell the value for the --sort option on the command line. > Makes sense. > > diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt > > index b424a1bc48bb..2d246725aeb5 100644 > > --- a/Documentation/git-tag.txt > > +++ b/Documentation/git-tag.txt > > @@ -317,6 +317,7 @@ include::date-formats.txt[] > > SEE ALSO > > -------- > > linkgit:git-check-ref-format[1]. > > +linkgit:git-config[1]. > > It is not particularly friendly to readers to refer to > "git-config[1]" from any other page, if done without spelling out > which variable the reader is expected to look up. Some addition > to the description of the "--sort" option is needed if this SEE ALSO > were to be any useful, I guess? > > --sort=<type>:: > ... (existing description) ... > When this option is not given, the sort order > defaults to the value configured for the `tag.sort` > variable, if exists, or lexicographic otherwise. > > or something like that, perhaps? > Alright, this sounds good too. > > diff --git a/builtin/tag.c b/builtin/tag.c > > index 7ccb6f3c581b..a53e27d4e7e4 100644 > > --- a/builtin/tag.c > > +++ b/builtin/tag.c > > @@ -18,6 +18,8 @@ > > #include "sha1-array.h" > > #include "column.h" > > > > +static int tag_sort = 0; > > Please do not initialize variables in bss segment to 0 by hand. > > If this variable is meant to take one of these *CMP_SORT values > defined as macro later in this file, it is better to define this > variable somewhere after and close to the definitions of the macros. > Perhaps immediately after the "struct tag_filter" is declared? > I put it just above the struct tag_filter now, as this puts it right below the #defines regarding it's value. > > @@ -346,9 +348,33 @@ static const char tag_template_nocleanup[] = > > "Lines starting with '%c' will be kept; you may remove them" > > " yourself if you want to.\n"); > > > > +static int parse_sort_string(const char *arg) > > +{ > > + int sort = 0; > > + int flags = 0; > > + > > + if (skip_prefix(arg, "-", &arg)) > > + flags |= REVERSE_SORT; > > + > > + if (skip_prefix(arg, "version:", &arg) || skip_prefix(arg, "v:", &arg)) > > + sort = VERCMP_SORT; > > + > > + if (strcmp(arg, "refname")) > > + die(_("unsupported sort specification %s"), arg); > > Hmm. I _thought_ we try to catch unsupported option value coming > from the command line and die but at the same time we try *not* to > die but warn and whatever is sensible when the value comes from the > configuration, so that .git/config or $HOME/.gitconfig can be shared > by those who use different versions of Git. > > Do we already have many precedences where we see configuration value > that our version of Git do not yet understand? > > Not a very strong objection; just something that worries me. > I like this change, and I think I have a way to handle it. I will re-work this so that the die is handled by the normal block. > > + sort |= flags; > > + > > + return sort; > > +} > > + > > static int git_tag_config(const char *var, const char *value, void *cb) > > { > > - int status = git_gpg_config(var, value, cb); > > + int status; > > + > > + if (!strcmp(var, "tag.sort")) { > > + tag_sort = parse_sort_string(value); > > + } > > + > > Why doesn't this return success after noticing that the variable is > to be interpreted by this block and nobody else? > I was copying the git_gpg_config. But yes I agree, returning here would make sense, and actually maybe fix git_gpg_config as well in a future patch. > When there is no reason to have things in a particular order, it is > customary to add new things at the end, not in the front, unless the > new thing is so much more important than everything else---but then > we are no longer talking about the case where there is no reason to > have things in a particular order ;-). > > Remainder of the changes to builtin/tag.c looks good. Thanks. > > > diff --git a/t/t7004-tag.sh b/t/t7004-tag.sh > > index e4ab0f5b6419..1e8300f6ed7c 100755 > > --- a/t/t7004-tag.sh > > +++ b/t/t7004-tag.sh > > @@ -1423,6 +1423,27 @@ EOF > > test_cmp expect actual > > ' > > > > +test_expect_success 'configured lexical sort' ' > > + git config tag.sort "v:refname" && > > + git tag -l "foo*" >actual && > > + cat >expect <<EOF && > > +foo1.3 > > +foo1.6 > > +foo1.10 > > +EOF > > + test_cmp expect actual > > +' > > Please write the above like so: > > ... > cat >expect <<-\EOF && > foo1.3 > ... > EOF > test_cmp expect actual > > The dash immediately after the here-doc redirection lets us indent > the data with HT to allow the test boundaries easier to spot, and by > quoting the token to end here-doc, we relieve the readers from > having to wonder if there are variable substitutions going on that > they need to be careful about. > > Overall, I think this is done well. Thanks for working on it. > -- Yep. I'll try to have a new version soon. Regards, Jake > To unsubscribe from this list: send the line "unsubscribe git" in > the body of a message to majordomo@vger.kernel.org > More majordomo info at http://vger.kernel.org/majordomo-info.html ^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH 2/2 v4] tag: support configuring --sort via .gitconfig 2014-07-11 16:20 ` Keller, Jacob E @ 2014-07-11 16:28 ` Junio C Hamano 0 siblings, 0 replies; 10+ messages in thread From: Junio C Hamano @ 2014-07-11 16:28 UTC (permalink / raw) To: Keller, Jacob E; +Cc: git@vger.kernel.org, peff@peff.net "Keller, Jacob E" <jacob.e.keller@intel.com> writes: > On Fri, 2014-07-11 at 08:04 -0700, Junio C Hamano wrote: > ... >> > +static int tag_sort = 0; >> >> Please do not initialize variables in bss segment to 0 by hand. >> >> If this variable is meant to take one of these *CMP_SORT values >> defined as macro later in this file, it is better to define this >> variable somewhere after and close to the definitions of the macros. >> Perhaps immediately after the "struct tag_filter" is declared? > > I put it just above the struct tag_filter now, as this puts it right > below the #defines regarding it's value. Either would be fine, but just to clarify. Because these macro definitions are for the .sort field of that structure, and the new tag_sort variable is the second user of that macro, my suggestion to put it _after_ was to be in line with "add new things at the end, when there is no compelling reason not to" below. >> When there is no reason to have things in a particular order, it is >> customary to add new things at the end, not in the front, unless the >> new thing is so much more important than everything else---but then >> we are no longer talking about the case where there is no reason to >> have things in a particular order ;-). Thanks. ^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH 2/2 v4] tag: support configuring --sort via .gitconfig 2014-07-11 15:04 ` Junio C Hamano 2014-07-11 16:20 ` Keller, Jacob E @ 2014-07-11 16:40 ` Keller, Jacob E 2014-07-11 18:29 ` Junio C Hamano 2014-07-11 17:20 ` Keller, Jacob E 2 siblings, 1 reply; 10+ messages in thread From: Keller, Jacob E @ 2014-07-11 16:40 UTC (permalink / raw) To: gitster@pobox.com; +Cc: git@vger.kernel.org, peff@peff.net On Fri, 2014-07-11 at 08:04 -0700, Junio C Hamano wrote: > Jacob Keller <jacob.e.keller@intel.com> writes: > > > Add support for configuring default sort ordering for git tags. Command > > line option will override this configured value, using the exact same > > syntax. > > > > Cc: Jeff King <peff@peff.net> > > Signed-off-by: Jacob Keller <jacob.e.keller@intel.com> > > --- > > - v4 > > * base on top of suggested change by Jeff King to use skip_prefix instead > > > > Documentation/config.txt | 6 ++++++ > > Documentation/git-tag.txt | 1 + > > builtin/tag.c | 46 ++++++++++++++++++++++++++++++++-------------- > > t/t7004-tag.sh | 21 +++++++++++++++++++++ > > 4 files changed, 60 insertions(+), 14 deletions(-) > > > > diff --git a/Documentation/config.txt b/Documentation/config.txt > > index 1d718bdb9662..ad8e75fed988 100644 > > --- a/Documentation/config.txt > > +++ b/Documentation/config.txt > > @@ -2354,6 +2354,12 @@ submodule.<name>.ignore:: > > "--ignore-submodules" option. The 'git submodule' commands are not > > affected by this setting. > > > > +tag.sort:: > > + This variable is used to control the sort ordering of tags. It is > > + interpreted precisely the same way as "--sort=<value>". If --sort is > > + given on the command line it will override the selection chosen in the > > + configuration. See linkgit:git-tag[1] for more details. > > + > > This is not technically incorrect per-se, but the third sentence > talks about "--sort" on "the command line" while this applies only > to "the command line of the 'git tag' command" and nobody else's > "--sort" option. > > Perhaps rephrasing it like this may be easier to understand? > > When "git tag" command is used to list existing tags, > without "--sort=<value>" option on the command line, > the value of this variable is used as the default. > > This way, it would be clear, without explicitly saying anything, > that the value will be spelled exactly the same way as you would > spell the value for the --sort option on the command line. > > > diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt > > index b424a1bc48bb..2d246725aeb5 100644 > > --- a/Documentation/git-tag.txt > > +++ b/Documentation/git-tag.txt > > @@ -317,6 +317,7 @@ include::date-formats.txt[] > > SEE ALSO > > -------- > > linkgit:git-check-ref-format[1]. > > +linkgit:git-config[1]. > > It is not particularly friendly to readers to refer to > "git-config[1]" from any other page, if done without spelling out > which variable the reader is expected to look up. Some addition > to the description of the "--sort" option is needed if this SEE ALSO > were to be any useful, I guess? > > --sort=<type>:: > ... (existing description) ... > When this option is not given, the sort order > defaults to the value configured for the `tag.sort` > variable, if exists, or lexicographic otherwise. > > or something like that, perhaps? > > > diff --git a/builtin/tag.c b/builtin/tag.c > > index 7ccb6f3c581b..a53e27d4e7e4 100644 > > --- a/builtin/tag.c > > +++ b/builtin/tag.c > > @@ -18,6 +18,8 @@ > > #include "sha1-array.h" > > #include "column.h" > > > > +static int tag_sort = 0; > > Please do not initialize variables in bss segment to 0 by hand. > > If this variable is meant to take one of these *CMP_SORT values > defined as macro later in this file, it is better to define this > variable somewhere after and close to the definitions of the macros. > Perhaps immediately after the "struct tag_filter" is declared? > > > @@ -346,9 +348,33 @@ static const char tag_template_nocleanup[] = > > "Lines starting with '%c' will be kept; you may remove them" > > " yourself if you want to.\n"); > > > > +static int parse_sort_string(const char *arg) > > +{ > > + int sort = 0; > > + int flags = 0; > > + > > + if (skip_prefix(arg, "-", &arg)) > > + flags |= REVERSE_SORT; > > + > > + if (skip_prefix(arg, "version:", &arg) || skip_prefix(arg, "v:", &arg)) > > + sort = VERCMP_SORT; > > + > > + if (strcmp(arg, "refname")) > > + die(_("unsupported sort specification %s"), arg); > > Hmm. I _thought_ we try to catch unsupported option value coming > from the command line and die but at the same time we try *not* to > die but warn and whatever is sensible when the value comes from the > configuration, so that .git/config or $HOME/.gitconfig can be shared > by those who use different versions of Git. > > Do we already have many precedences where we see configuration value > that our version of Git do not yet understand? > > Not a very strong objection; just something that worries me. > > > + sort |= flags; > > + > > + return sort; > > +} > > + > > static int git_tag_config(const char *var, const char *value, void *cb) > > { > > - int status = git_gpg_config(var, value, cb); > > + int status; > > + > > + if (!strcmp(var, "tag.sort")) { > > + tag_sort = parse_sort_string(value); > > + } > > + > > Why doesn't this return success after noticing that the variable is > to be interpreted by this block and nobody else? > > When there is no reason to have things in a particular order, it is > customary to add new things at the end, not in the front, unless the > new thing is so much more important than everything else---but then > we are no longer talking about the case where there is no reason to > have things in a particular order ;-). > > Remainder of the changes to builtin/tag.c looks good. > > > diff --git a/t/t7004-tag.sh b/t/t7004-tag.sh > > index e4ab0f5b6419..1e8300f6ed7c 100755 > > --- a/t/t7004-tag.sh > > +++ b/t/t7004-tag.sh > > @@ -1423,6 +1423,27 @@ EOF > > test_cmp expect actual > > ' > > > > +test_expect_success 'configured lexical sort' ' > > + git config tag.sort "v:refname" && > > + git tag -l "foo*" >actual && > > + cat >expect <<EOF && > > +foo1.3 > > +foo1.6 > > +foo1.10 > > +EOF > > + test_cmp expect actual > > +' > > Please write the above like so: > > ... > cat >expect <<-\EOF && > foo1.3 > ... > EOF > test_cmp expect actual > > The dash immediately after the here-doc redirection lets us indent > the data with HT to allow the test boundaries easier to spot, and by > quoting the token to end here-doc, we relieve the readers from > having to wonder if there are variable substitutions going on that > they need to be careful about. This is not how the rest of the current tests work. I will submit a patch which fixes up the current --sort tests (but not every test, for now) as well. Thanks, Jake > > Overall, I think this is done well. Thanks for working on it. > -- > To unsubscribe from this list: send the line "unsubscribe git" in > the body of a message to majordomo@vger.kernel.org > More majordomo info at http://vger.kernel.org/majordomo-info.html ^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH 2/2 v4] tag: support configuring --sort via .gitconfig 2014-07-11 16:40 ` Keller, Jacob E @ 2014-07-11 18:29 ` Junio C Hamano 2014-07-11 20:37 ` Keller, Jacob E 0 siblings, 1 reply; 10+ messages in thread From: Junio C Hamano @ 2014-07-11 18:29 UTC (permalink / raw) To: Keller, Jacob E; +Cc: git@vger.kernel.org, peff@peff.net "Keller, Jacob E" <jacob.e.keller@intel.com> writes: > This is not how the rest of the current tests work. I will submit a > patch which fixes up the current --sort tests (but not every test, for > now) as well. I do not want to pile more work that is unrelated to the task at hand on your plate, i.e. clean-up work, so I would assign a very low priority to "fix up the current tests". At the same time, existing mistakes are not excuses to introduce new similar ones, hence my suggestions to the added code in the patch I saw. ^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH 2/2 v4] tag: support configuring --sort via .gitconfig 2014-07-11 18:29 ` Junio C Hamano @ 2014-07-11 20:37 ` Keller, Jacob E 0 siblings, 0 replies; 10+ messages in thread From: Keller, Jacob E @ 2014-07-11 20:37 UTC (permalink / raw) To: gitster@pobox.com; +Cc: git@vger.kernel.org, peff@peff.net On Fri, 2014-07-11 at 11:29 -0700, Junio C Hamano wrote: > "Keller, Jacob E" <jacob.e.keller@intel.com> writes: > > > This is not how the rest of the current tests work. I will submit a > > patch which fixes up the current --sort tests (but not every test, for > > now) as well. > > I do not want to pile more work that is unrelated to the task at > hand on your plate, i.e. clean-up work, so I would assign a very low > priority to "fix up the current tests". At the same time, existing > mistakes are not excuses to introduce new similar ones, hence my > suggestions to the added code in the patch I saw. > It was trivial to fix at least the --sort tests, so I submitted a patch that goes before this one to fix those as well. Thanks, Jake ^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH 2/2 v4] tag: support configuring --sort via .gitconfig 2014-07-11 15:04 ` Junio C Hamano 2014-07-11 16:20 ` Keller, Jacob E 2014-07-11 16:40 ` Keller, Jacob E @ 2014-07-11 17:20 ` Keller, Jacob E 2 siblings, 0 replies; 10+ messages in thread From: Keller, Jacob E @ 2014-07-11 17:20 UTC (permalink / raw) To: gitster@pobox.com; +Cc: git@vger.kernel.org, peff@peff.net On Fri, 2014-07-11 at 08:04 -0700, Junio C Hamano wrote: > Jacob Keller <jacob.e.keller@intel.com> writes: > > > + > > + if (strcmp(arg, "refname")) > > + die(_("unsupported sort specification %s"), arg); > > Hmm. I _thought_ we try to catch unsupported option value coming > from the command line and die but at the same time we try *not* to > die but warn and whatever is sensible when the value comes from the > configuration, so that .git/config or $HOME/.gitconfig can be shared > by those who use different versions of Git. > > Do we already have many precedences where we see configuration value > that our version of Git do not yet understand? > > Not a very strong objection; just something that worries me. Based on a cursory glance at how the config is parsed, we actually die_on_error for most options. Does it makes sense to warn or not? I am not really sure here.. At any rate I updated this to be a bit cleaner and use error( instead of die, so that it will work within how config is supposed to.. Plus, this also makes it so that --sort shows the usage if it's invalid. Please comment more on the new set I am sending so we can really determine what the correct course of action is here. Regards, Jake ^ permalink raw reply [flat|nested] 10+ messages in thread
* Re: [PATCH 2/2 v4] tag: support configuring --sort via .gitconfig 2014-07-10 23:52 ` [PATCH 2/2 v4] tag: support configuring --sort via .gitconfig Jacob Keller 2014-07-11 15:04 ` Junio C Hamano @ 2014-07-16 0:55 ` Duy Nguyen 1 sibling, 0 replies; 10+ messages in thread From: Duy Nguyen @ 2014-07-16 0:55 UTC (permalink / raw) To: Jacob Keller; +Cc: Git Mailing List, Jeff King On Fri, Jul 11, 2014 at 6:52 AM, Jacob Keller <jacob.e.keller@intel.com> wrote: > Add support for configuring default sort ordering for git tags. Command > line option will override this configured value, using the exact same > syntax. Kinda off topic, but I wish we could show these default overriding settings when GIT_TRACE is set. E.g. if this knob is set, GIT_TRACE would show 'git' 'tag' '--version=....' even though --version is not specified from command line. Or some other way to know which knobs are active when a command is run. -- Duy ^ permalink raw reply [flat|nested] 10+ messages in thread
end of thread, other threads:[~2014-07-16 0:56 UTC | newest] Thread overview: 10+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2014-07-10 23:52 [PATCH 1/2] tag: use skip_prefix instead of magic numbers Jacob Keller 2014-07-10 23:52 ` [PATCH 2/2 v4] tag: support configuring --sort via .gitconfig Jacob Keller 2014-07-11 15:04 ` Junio C Hamano 2014-07-11 16:20 ` Keller, Jacob E 2014-07-11 16:28 ` Junio C Hamano 2014-07-11 16:40 ` Keller, Jacob E 2014-07-11 18:29 ` Junio C Hamano 2014-07-11 20:37 ` Keller, Jacob E 2014-07-11 17:20 ` Keller, Jacob E 2014-07-16 0:55 ` Duy Nguyen
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 NNTP newsgroup(s).