Re: [PATCH v3] Documentation fix: git log -p does not imply -c.

From: Junio C Hamano <gitster@pobox.com>
Date: Mar 8, 2011, 00:21 UTC
Message-ID: <7vsjuyzckd.fsf@alter.siamese.dyndns.org>
In-Reply-To: <1299535063-1020-1-git-send-email-haircut@gmail.com>

Adam Monsen <haircut@gmail.com> writes:

> This is really Peff's patch, I
> * fixed a typo (vie -> view)
> * am sending it as an acutal patch in case that's easier to apply than
>   a diff in an email

Thanks. Such a patch to summarize the discussion so far is greatly appreciated.

Show 17 quoted lines

>  Documentation/diff-generate-patch.txt |   10 ++++++----
>  1 files changed, 6 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/diff-generate-patch.txt b/Documentation/diff-generate-patch.txt
> index 3ac2bea..5d478c1 100644
> --- a/Documentation/diff-generate-patch.txt
> +++ b/Documentation/diff-generate-patch.txt
> @@ -74,10 +74,12 @@ separate lines indicate the old and the new mode.
>  combined diff format
>  --------------------
>  
> -"git-diff-tree", "git-diff-files" and "git-diff" can take '-c' or
> -'--cc' option to produce 'combined diff'.  For showing a merge commit
> -with "git log -p", this is the default format; you can force showing
> -full diff with the '-m' option.
> +Any diff-generating command can take the `-c` or `--cc` option to
> +produced a 'combined diff' when showing a merge. This is the default

s/produced/produce/, I think.

> +format when showing merge conflicts with linkgit:git-diff[1] or a merge
> +commit with linkgit:git-show[1]. Note also that you can view the full
> +diff with the `-m` option.

This "Note" is a bit unclear what command it applies to, isn't it? I know it applies to all the commands mentioned in the previous sentence in the paragraph, but we are not writing the documentation for me, so perhaps

	Note also that you can give the `-m' option to any of these
	commands to force generation of diffs with individual parents of a
	merge.

Also -c and --cc are technically _not_ about "showing merge conflicts". It is about "showing a merge commit". I don't know if we want to teach the distinction in this part of the document, though.

If you resolve a conflicted merge taking the results from only one side for a given hunk, --cc won't show anything. If on the other hand, you futz with a clean merge so that your result does not match with any parent, --cc will show it.

Cf.

 http://thread.gmane.org/gmane.comp.version-control.git/89415