Re: [PATCH v3 1/4] Documentation: clarify %(contents:XXXX) doc

From: Christian Couder <christian.couder@gmail.com>
Date: Jul 10, 2020, 16:47 UTC
Message-ID: <CAP8UFD2vxYHvVV8nUBArCGNJTS9K1ynZ1LCBU1BBPBi9d5L77w@mail.gmail.com>
In-Reply-To: <xmqqsge33z42.fsf@gitster.c.googlers.com>

On Tue, Jul 7, 2020 at 9:26 PM Junio C Hamano <gitster@pobox.com> wrote:

>
> Christian Couder <christian.couder@gmail.com> writes:

Show 10 quoted lines

> > +contents:subject::
> > +     The "subject" of the commit or tag message.  It's actually the
> > +     concatenation of all lines of the commit message up to the
> > +     first blank line.
>
> Let's avoid confusing readers by saying "A is X. It's actually Y".
>
>     The first paragraph of the message, which typically is a single
>     line, is taken as the "subject" of the commit or the tag
>     message.

Ok.

Show 6 quoted lines

> > +contents:body::
> > +     The "body" of the commit or tag message.  It's made of the
> > +     lines after the first blank line.
>
>     The remainder of the commit or the tag message that follows the
>     "subject".

Ok.

Show 6 quoted lines

> > +contents:signature::
> > +     The optional GPG signature.
>
> I _think_ this only applies to signed tag objects and not signed
> commit objects, but this text does not help to decide if I am
> right.

You are right. It doesn't work for commits:

--------------------------------------------------- $ git cat-file commit refs/heads/signed_commit tree 9773e6a54521a5d99928685e5f62e937fc6a7593 parent 1d1083b4c06fbb6055a2bd3d665a6d81468db5f5 author Christian Couder <chriscool@tuxfamily.org> 1594397089 +0200 committer Christian Couder <chriscool@tuxfamily.org> 1594397089 +0200 gpgsig -----BEGIN PGP SIGNATURE-----

 iQGzBAABCgAdFiEElaRidyyI6IQbXM36ch8PKcZMVRkFAl8IkaEACgkQch8PKcZM
[...]
 dkYKcRC3
 =fRMN
 -----END PGP SIGNATURE-----

Signed commit $ git for-each-ref --format='%(contents:signature)' refs/heads/signed_commit

---------------------------------------------------

So I changed the description to:

contents:signature::
    The optional GPG signature of the tag.