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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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

> +* 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?
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html




[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]