[PATCH/RFC v3 2/4] git-am.txt: add configuration section in git am documentation

From: Remi Lespinet <remi.lespinet@ensimag.grenoble-inp.fr>
Date: Jun 3, 2015, 08:26 UTC
Message-ID: <217974219.58943.1433319994168.JavaMail.zimbra@ensimag.grenoble-inp.fr>
In-Reply-To: <556E95AC.7040305@web.de>

Show 15 quoted lines

> On 06/03/2015 07:50 AM Torsten Bögershausen <tboegi@web.de> wrote
>
> > +CONFIGURATION
> > +-------------
> > +
> > +am.keepcr::
> > +        If true, git-am will call git-mailsplit for patches in mbox format
> > +        with parameter '--keep-cr'. In this case git-mailsplit will
> > +        not remove `\r` from lines ending with `\r\n`. Can be overridden
> > +        by giving '--no-keep-cr' from the command line.
> (This documentation assumes that am.keepcr is true)
> Would it be clearer to put the "overridden" into one line and write like
> this:
> 
> Can be overridden by giving '--no-keep-cr' or '--keep-cr' from the command line.

Yes I agree, or maybe:

'--keep-cr' and '--no-keep-cr' take precedence over this variable.

Actually, I don't know if we need to write it (as Paul Tan suggested in the previous version of this patch for the threeway option http://article.gmane.org/gmane.comp.version-control.git/270150)

I checked the documentation of different commands. From what I've seen, such indications either does not appear or are right after the text. I agree that it's a good idea, but for the sake of consistency, I'd rather use one of these two format as long as it's ok for you.