Re: bug? illegal text in commit log

From: Junio C Hamano <gitster@pobox.com>
Date: Feb 6, 2020, 16:17 UTC
Message-ID: <xmqqlfpfg05t.fsf@gitster-ct.c.googlers.com>
In-Reply-To: <20200206012854-mutt-send-email-mst@kernel.org>

"Michael S. Tsirkin" <mst@redhat.com> writes:

Show 14 quoted lines

> It might be intended for other purposes, for example instructions:
>
> To try out the new foobar flag, execute the following script:
>
> git apply --foobar << EOF
> --- a.txt       2020-02-04 01:09:27.927026571 -0500
> +++ c.txt       2020-02-04 01:06:57.404688233 -0500
> @@ -1 +1 @@
> -AA
> +BB
> EOF
>
> indenting would break the script, and make it harder for users
> to follow the instructions.

Sorry, but that sounds like a made-up example to me.

Why would anybody write that in the log message, instead of placing it in the documentation? The log message will be lost to those who receive tarballs, and even to those who clone the source it needs active effort to dig one particular change out.