Re: [PATCH v2] [GSOC] pretty: provide human date format

From: Philip Oakley <philipoakley@iee.email>
Date: Apr 24, 2021, 19:44 UTC
Message-ID: <c0780b56-8852-d055-97ec-45ff93aa41de@iee.email>
In-Reply-To: <pull.939.v2.git.1619275340051.gitgitgadget@gmail.com>

quoting nit.. On 24/04/2021 15:42, ZheNing Hu via GitGitGadget wrote:

Show 63 quoted lines

> From: ZheNing Hu <adlternative@gmail.com>
>
> Add the placeholders %ah and %ch to format author date and committer
> date, like --date=human does, which provides more humanity date output.
>
> Signed-off-by: ZheNing Hu <adlternative@gmail.com>
> ---
>     [GSOC] pretty: provide human date format
>     
>     Reasons for making this patch: --date=human has no corresponding
>     --pretty option.
>     
>     Although --date=human with --pretty="%(a|c)d" can achieve the same
>     effect with --pretty="%(a|c)h", but it can be noticed that most time
>     formats implement the corresponding option of --pretty, such as
>     --date=iso8601 can be replaced by --pretty=%(a|c)i, so add
>     "--pretty=%(a|c)h" seems to be a very reasonable thing.
>     
>     Change from v1: add %(a|c)h link to rev-list-options.txt.
>
> Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-939%2Fadlternative%2Fpretty_human-v2
> Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-939/adlternative/pretty_human-v2
> Pull-Request: https://github.com/gitgitgadget/git/pull/939
>
> Range-diff vs v1:
>
>  1:  ed8abd6179d1 ! 1:  1517708876b5 [GSOC] pretty: provide human date format
>      @@ Documentation/pretty-formats.txt: The placeholders are:
>        '%ai':: author date, ISO 8601-like format
>        '%aI':: author date, strict ISO 8601 format
>        '%as':: author date, short format (`YYYY-MM-DD`)
>      -+'%ah':: author date, human style
>      ++'%ah':: author date, human style (like the --date=human option of
>      ++	linkgit:rev-list-options.txt[1])
>        '%cn':: committer name
>        '%cN':: committer name (respecting .mailmap, see
>        	linkgit:git-shortlog[1] or linkgit:git-blame[1])
>      @@ Documentation/pretty-formats.txt: The placeholders are:
>        '%ci':: committer date, ISO 8601-like format
>        '%cI':: committer date, strict ISO 8601 format
>        '%cs':: committer date, short format (`YYYY-MM-DD`)
>      -+'%ch':: committer date, human style
>      ++'%ch':: committer date, human style(like the --date=human option of
>      ++	linkgit:rev-list-options.txt[1])
>        '%d':: ref names, like the --decorate option of linkgit:git-log[1]
>        '%D':: ref names without the " (", ")" wrapping.
>        '%(describe[:options])':: human-readable name, like
>
>
>  Documentation/pretty-formats.txt | 4 ++++
>  pretty.c                         | 3 +++
>  t/t4205-log-pretty-formats.sh    | 6 ++++++
>  3 files changed, 13 insertions(+)
>
> diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt
> index 45133066e412..e37d5cbb6b16 100644
> --- a/Documentation/pretty-formats.txt
> +++ b/Documentation/pretty-formats.txt
> @@ -190,6 +190,8 @@ The placeholders are:
>  '%ai':: author date, ISO 8601-like format
>  '%aI':: author date, strict ISO 8601 format
>  '%as':: author date, short format (`YYYY-MM-DD`)
> +'%ah':: author date, human style (like the --date=human option of

shouldn't that option be quoted " `--date=human` " so as to match the format in rev-list?

> +	linkgit:rev-list-options.txt[1])

Also. Is this right? Shouldn't it just link to the dashed git- command's
man page, rather than the file, i.e.
 linkgit:git-rev-list[1])

Show 8 quoted lines

>  '%cn':: committer name
>  '%cN':: committer name (respecting .mailmap, see
>  	linkgit:git-shortlog[1] or linkgit:git-blame[1])
> @@ -206,6 +208,8 @@ The placeholders are:
>  '%ci':: committer date, ISO 8601-like format
>  '%cI':: committer date, strict ISO 8601 format
>  '%cs':: committer date, short format (`YYYY-MM-DD`)
> +'%ch':: committer date, human style(like the --date=human option of

likewise, quote the option ? and resolve the linkgit: to the man page

Show 37 quoted lines

> +	linkgit:rev-list-options.txt[1])
>  '%d':: ref names, like the --decorate option of linkgit:git-log[1]
>  '%D':: ref names without the " (", ")" wrapping.
>  '%(describe[:options])':: human-readable name, like
> diff --git a/pretty.c b/pretty.c
> index e5b33ba034bd..b1ecd039cef2 100644
> --- a/pretty.c
> +++ b/pretty.c
> @@ -745,6 +745,9 @@ static size_t format_person_part(struct strbuf *sb, char part,
>  	case 'I':	/* date, ISO 8601 strict */
>  		strbuf_addstr(sb, show_ident_date(&s, DATE_MODE(ISO8601_STRICT)));
>  		return placeholder_len;
> +	case 'h':	/* date, human */
> +		strbuf_addstr(sb, show_ident_date(&s, DATE_MODE(HUMAN)));
> +		return placeholder_len;
>  	case 's':
>  		strbuf_addstr(sb, show_ident_date(&s, DATE_MODE(SHORT)));
>  		return placeholder_len;
> diff --git a/t/t4205-log-pretty-formats.sh b/t/t4205-log-pretty-formats.sh
> index cabdf7d57a00..d4d75b0b350e 100755
> --- a/t/t4205-log-pretty-formats.sh
> +++ b/t/t4205-log-pretty-formats.sh
> @@ -539,6 +539,12 @@ test_expect_success 'short date' '
>  	test_cmp expected actual
>  '
>  
> +test_expect_success 'human date' '
> +	git log --format=%ad%n%cd --date=human >expected &&
> +	git log --format=%ah%n%ch >actual &&
> +	test_cmp expected actual
> +'
> +
>  # get new digests (with no abbreviations)
>  test_expect_success 'set up log decoration tests' '
>  	head1=$(git rev-parse --verify HEAD~0) &&
>
> base-commit: b0c09ab8796fb736efa432b8e817334f3e5ee75a

Looks good otherwise. Philip