[PATCH] Documentation gitk: Describe what --merge does

[PATCH] Documentation gitk: Describe what --merge does

[Richard Quirk]

Signed-off-by: Richard Quirk <richard.quirk@gmail.com>
---
 Documentation/gitk.txt |    5 +++++
 1 files changed, 5 insertions(+), 0 deletions(-)

diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt
index ed3ba83..edd6547 100644
--- a/Documentation/gitk.txt
+++ b/Documentation/gitk.txt
@@ -41,6 +41,11 @@ frequently used options.
 
 	Show all branches.
 
+--merge::
+
+	Show the differences between HEAD and MERGE_HEAD for files with
+	conflicts after a merge.
+
 <revs>::
 
 	Limit the revisions to show. This can be either a single revision
-- 
1.5.5.1.79.g57cf

Re: [PATCH] Documentation gitk: Describe what --merge does

[Junio C Hamano]

Richard Quirk <richard.quirk@gmail.com> writes:

> Signed-off-by: Richard Quirk <richard.quirk@gmail.com>
> ---
>  Documentation/gitk.txt |    5 +++++
>  1 files changed, 5 insertions(+), 0 deletions(-)
>
> diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt
> index ed3ba83..edd6547 100644
> --- a/Documentation/gitk.txt
> +++ b/Documentation/gitk.txt
> @@ -41,6 +41,11 @@ frequently used options.
>  
>  	Show all branches.
>  
> +--merge::
> +
> +	Show the differences between HEAD and MERGE_HEAD for files with
> +	conflicts after a merge.
> +

Hmm. "the differences" is technically correct in that it shows the
commits on the diverged histories, but I suspect it would be more
understandable if we used more explicit wording, like:

	After an attempt to merge stops with conflicts, show the commits
	on the history between two branches (i.e. the HEAD and the
	MERGE_HEAD) that modify the conflicted files.

[PATCH] Documentation gitk: Describe what --merge does

[Richard Quirk]

Signed-off-by: Richard Quirk <richard.quirk@gmail.com>
---

On Sun, Apr 27, 2008 at 10:37 PM, Junio C Hamano <gitster@pobox.com> wrote:
>  Hmm. "the differences" is technically correct in that it shows the
>  commits on the diverged histories, but I suspect it would be more
>  understandable if we used more explicit wording

Yes, and your explicit wording was much clearer.

I'm not sure if resending this is strictly the Right Thing given that the
words are actually yours. But here's the updated patch so --merge might get
some documentation, just in case.

 Documentation/gitk.txt |    6 ++++++
 1 files changed, 6 insertions(+), 0 deletions(-)

diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt
index ed3ba83..c40f997 100644
--- a/Documentation/gitk.txt
+++ b/Documentation/gitk.txt
@@ -41,6 +41,12 @@ frequently used options.
 
 	Show all branches.
 
+--merge::
+
+	After an attempt to merge stops with conflicts, show the commits on
+	the history between two branches (i.e. the HEAD and the MERGE_HEAD)
+	that modify the conflicted files.
+
 <revs>::
 
 	Limit the revisions to show. This can be either a single revision
-- 
1.5.5.1.91.gb5ae