| Message ID | 20211026013452.1372122-3-eschwartz@archlinux.org (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | Add some more options to the pretty-formats | expand |
On Mon, Oct 25, 2021 at 9:36 PM Eli Schwartz <eschwartz@archlinux.org> wrote: > The %(describe) placeholder by default, like `git describe`, only > supports annotated tags. However, some people do use lightweight tags > for releases, and would like to describe those anyway. The command line > tool has an option to support this. > > Teach the placeholder to support this as well. > > Signed-off-by: Eli Schwartz <eschwartz@archlinux.org> > --- > diff --git a/pretty.c b/pretty.c > @@ -1229,10 +1230,21 @@ static size_t parse_describe_args(const char *start, struct strvec *args) > for (i = 0; !found && i < ARRAY_SIZE(option); i++) { > switch(option[i].type) { > + case OPT_BOOL: > + if(match_placeholder_bool_arg(arg, option[i].name, &arg, &optval)) { Style nit: add space after `if` > + if (optval) { > + strvec_pushf(args, "--%s", option[i].name); > + } else { > + strvec_pushf(args, "--no-%s", option[i].name); > + } We would normally omit the braces for this simple `if`: if (optval) strvec_pushf(...); else strvec_pushf(...); ... or maybe even use the ternary operator: strvec_pushf(args, "--%s%s", optval ? "" : "no-", option[i].name); but it's highly subjective whether or not that's more readable.
On 10/26/21 1:25 AM, Eric Sunshine wrote: > On Mon, Oct 25, 2021 at 9:36 PM Eli Schwartz <eschwartz@archlinux.org> wrote: >> The %(describe) placeholder by default, like `git describe`, only >> supports annotated tags. However, some people do use lightweight tags >> for releases, and would like to describe those anyway. The command line >> tool has an option to support this. >> >> Teach the placeholder to support this as well. >> >> Signed-off-by: Eli Schwartz <eschwartz@archlinux.org> >> --- >> diff --git a/pretty.c b/pretty.c >> @@ -1229,10 +1230,21 @@ static size_t parse_describe_args(const char *start, struct strvec *args) >> for (i = 0; !found && i < ARRAY_SIZE(option); i++) { >> switch(option[i].type) { >> + case OPT_BOOL: >> + if(match_placeholder_bool_arg(arg, option[i].name, &arg, &optval)) { > > Style nit: add space after `if` Oops, I am not sure how this happened. It's wrong in the switch too. >> + if (optval) { >> + strvec_pushf(args, "--%s", option[i].name); >> + } else { >> + strvec_pushf(args, "--no-%s", option[i].name); >> + } > > We would normally omit the braces for this simple `if`: > > if (optval) > strvec_pushf(...); > else > strvec_pushf(...); > > ... or maybe even use the ternary operator: > > strvec_pushf(args, "--%s%s", optval ? "" : "no-", option[i].name); > > but it's highly subjective whether or not that's more readable. Although the braces feel more natural to me for clarity purposes, it's a good point that the git coding style says to omit them for single statements, and I should have followed that here. The ternary doesn't feel readable to me, however. ... Thanks for the style review!
diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt index ef6bd420ae..86ed801aad 100644 --- a/Documentation/pretty-formats.txt +++ b/Documentation/pretty-formats.txt @@ -220,6 +220,8 @@ The placeholders are: inconsistent when tags are added or removed at the same time. + +** 'tags[=<BOOL>]': Instead of only considering annotated tags, + consider lightweight tags as well. ** 'match=<pattern>': Only consider tags matching the given `glob(7)` pattern, excluding the "refs/tags/" prefix. ** 'exclude=<pattern>': Do not consider tags matching the given @@ -273,11 +275,6 @@ endif::git-rev-list[] If any option is provided multiple times the last occurrence wins. + -The boolean options accept an optional value `[=<BOOL>]`. The values -`true`, `false`, `on`, `off` etc. are all accepted. See the "boolean" -sub-section in "EXAMPLES" in linkgit:git-config[1]. If a boolean -option is given with no value, it's enabled. -+ ** 'key=<K>': only show trailers with specified key. Matching is done case-insensitively and trailing colon is optional. If option is given multiple times trailer lines matching any of the keys are @@ -313,6 +310,11 @@ insert an empty string unless we are traversing reflog entries (e.g., by decoration format if `--decorate` was not already provided on the command line. +The boolean options accept an optional value `[=<BOOL>]`. The values +`true`, `false`, `on`, `off` etc. are all accepted. See the "boolean" +sub-section in "EXAMPLES" in linkgit:git-config[1]. If a boolean +option is given with no value, it's enabled. + If you add a `+` (plus sign) after '%' of a placeholder, a line-feed is inserted immediately before the expansion if and only if the placeholder expands to a non-empty string. diff --git a/pretty.c b/pretty.c index f8b254d2ff..16b5366fed 100644 --- a/pretty.c +++ b/pretty.c @@ -1218,8 +1218,9 @@ static size_t parse_describe_args(const char *start, struct strvec *args) { struct { char *name; - enum { OPT_STRING } type; + enum { OPT_BOOL, OPT_STRING, } type; } option[] = { + { "tags", OPT_BOOL}, { "exclude", OPT_STRING }, { "match", OPT_STRING }, }; @@ -1229,10 +1230,21 @@ static size_t parse_describe_args(const char *start, struct strvec *args) int found = 0; const char *argval; size_t arglen = 0; + int optval = 0; int i; for (i = 0; !found && i < ARRAY_SIZE(option); i++) { switch(option[i].type) { + case OPT_BOOL: + if(match_placeholder_bool_arg(arg, option[i].name, &arg, &optval)) { + if (optval) { + strvec_pushf(args, "--%s", option[i].name); + } else { + strvec_pushf(args, "--no-%s", option[i].name); + } + found = 1; + } + break; case OPT_STRING: if (match_placeholder_arg_value(arg, option[i].name, &arg, &argval, &arglen) && arglen) { diff --git a/t/t4205-log-pretty-formats.sh b/t/t4205-log-pretty-formats.sh index 5865daa8f8..d4acf8882f 100755 --- a/t/t4205-log-pretty-formats.sh +++ b/t/t4205-log-pretty-formats.sh @@ -1002,4 +1002,12 @@ test_expect_success '%(describe:exclude=...) vs git describe --exclude ...' ' test_cmp expect actual ' +test_expect_success '%(describe:tags) vs git describe --tags' ' + test_when_finished "git tag -d tagname" && + git tag tagname && + git describe --tags >expect && + git log -1 --format="%(describe:tags)" >actual && + test_cmp expect actual +' + test_done
The %(describe) placeholder by default, like `git describe`, only supports annotated tags. However, some people do use lightweight tags for releases, and would like to describe those anyway. The command line tool has an option to support this. Teach the placeholder to support this as well. Signed-off-by: Eli Schwartz <eschwartz@archlinux.org> --- Documentation/pretty-formats.txt | 12 +++++++----- pretty.c | 14 +++++++++++++- t/t4205-log-pretty-formats.sh | 8 ++++++++ 3 files changed, 28 insertions(+), 6 deletions(-)