Re: [PATCH v15 11/11] Documentation: add documentation for 'git interpret-trailers'

From: Junio C Hamano <gitster@pobox.com>
Date: Sep 22, 2014, 21:23 UTC
Message-ID: <xmqqk34vjqni.fsf@gitster.dls.corp.google.com>
In-Reply-To: <20140920134515.18999.58095.chriscool@tuxfamily.org>

This has quite a few "trailing whitespace" errors in the patch in the documentation part. It would mean that people who try to follow along the examples would have difficult time deciphering where trailing whitespaces are necessary.

For example

Show 14 quoted lines

> +* Configure a commit template with some trailers with empty values,
> +  then configure a commit-msg hook that uses 'git interpret-trailers'
> +  to remove trailers with empty values and to add a 'git-version'
> +  trailer:
> ++
> +------------
> +$ cat >commit_template.txt <<EOF
> +> ***subject***
> +> 
> +> ***message***
> +> 
> +> Fixes: 
> +> Cc: 
> ...

This presents the example in the least useful way. The leading "> " are coming from $PS2 so people cannot cut & paste to follow along on their interactive shell session, but cutting and pasting from a machine-readable copy of the document would be the only way to preserve the trailing SP on lines that begin with Fixes:, Cc: and friends. On the other hand, those who type each line while eyeballing the documentation (because it is not cut-and-paste ready due to $PS2) may not spot the trailing SP on these lines.

Can we think of a way to make the necessary trailing SP stand out?