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

From: Junio C Hamano <[email-masked]>
Date: Tue, 02 Jun 2015 13:16:13 -0700

Remi Lespinet <[email-masked]> writes:

> Prepare a configuration section for the git am documentation.
> Remove the part related to the am.keepcr configuration variable in the
> description of the --keepcr option and place the description of the
> am.keepcr configuration variable in the newly created configuration
> section.
>
> This section will be used in the next commit.
>
> Signed-off-by: Remi Lespinet <[email-masked]>
> ---
>  Documentation/git-am.txt | 16 +++++++++++++---
>  1 file changed, 13 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
> index 0d8ba48..d412f6b 100644
> --- a/Documentation/git-am.txt
> +++ b/Documentation/git-am.txt
> @@ -24,6 +24,16 @@ Splits mail messages in a mailbox into commit log message,
>  authorship information and patches, and applies them to the
>  current branch.
>  
> +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.
> +	See linkgit:git-am[1], linkgit:git-mailsplit[1].

As this is git-am.txt, the first reference smells a bit odd.

Other than that, looks OK to me.

Thanks.

>  OPTIONS
>  -------
>  (<mbox>|<Maildir>)...::
> @@ -43,11 +53,11 @@ OPTIONS
>  --keep-non-patch::
>  	Pass `-b` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
>  
> ---[no-]keep-cr::
> +--keep-cr::
> +--no-keep-cr::
>  	With `--keep-cr`, call 'git mailsplit' (see linkgit:git-mailsplit[1])
>  	with the same option, to prevent it from stripping CR at the end of
> -	lines. `am.keepcr` configuration variable can be used to specify the
> -	default behaviour.  `--no-keep-cr` is useful to override `am.keepcr`.
> +	lines.
>  
>  -c::
>  --scissors::