diff mbox series

[2/2] doc: describe mergetool configuration in git-mergetool(1)

Message ID YEx6ve6AbqacVTQH@google.com (mailing list archive)
State Accepted
Commit 53204061acbf7a03a6ba050f381e0bf9b01e3a78
Headers show
Series mergetool: do not enable hideResolved by default | expand

Commit Message

Jonathan Nieder March 13, 2021, 8:41 a.m. UTC
In particular, this describes mergetool.hideResolved, which can help
users discover this setting (either because it may be useful to them
or in order to understand mergetool's behavior if they have forgotten
setting it in the past).

Tested by running

	make -C Documentation git-mergetool.1
	man Documentation/git-mergetool.1

and reading through the page.

Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
---
 Documentation/git-mergetool.txt | 4 ++++
 1 file changed, 4 insertions(+)

Thanks for reading.

Comments

Junio C Hamano March 13, 2021, 11:34 p.m. UTC | #1
Jonathan Nieder <jrnieder@gmail.com> writes:
> diff --git a/Documentation/git-mergetool.txt b/Documentation/git-mergetool.txt
> index 6b14702e784..e587c7763a7 100644
> --- a/Documentation/git-mergetool.txt
> +++ b/Documentation/git-mergetool.txt
> @@ -99,6 +99,10 @@ success of the resolution after the custom tool has exited.
>  	(see linkgit:git-config[1]).  To cancel `diff.orderFile`,
>  	use `-O/dev/null`.
>  
> +CONFIGURATION
> +-------------
> +include::config/mergetool.txt[]
> +

It is a nice touch.  We don't have much explanation other than the
description below ...

mergetool.hideResolved::
	During a merge Git will automatically resolve as many conflicts as
	possible and write the 'MERGED' file containing conflict markers around
	any conflicts that it cannot resolve; 'LOCAL' and 'REMOTE' normally
	represent the versions of the file from before Git's conflict
	resolution. This flag causes 'LOCAL' and 'REMOTE' to be overwriten so
	that only the unresolved conflicts are presented to the merge tool. Can
	be configured per-tool via the `mergetool.<tool>.hideResolved`
	configuration variable. Defaults to `false`.

... which appears in the included file on the feature.

Thanks.
Junio C Hamano March 13, 2021, 11:37 p.m. UTC | #2
Jonathan Nieder <jrnieder@gmail.com> writes:

> Tested by running
>
> 	make -C Documentation git-mergetool.1
> 	man Documentation/git-mergetool.1
>
> and reading through the page.

Nice.  Also applying this step and running

	cd Documentation && ./doc-diff HEAD^ HEAD

would was a trivial way to see the change ;-)
diff mbox series

Patch

diff --git a/Documentation/git-mergetool.txt b/Documentation/git-mergetool.txt
index 6b14702e784..e587c7763a7 100644
--- a/Documentation/git-mergetool.txt
+++ b/Documentation/git-mergetool.txt
@@ -99,6 +99,10 @@  success of the resolution after the custom tool has exited.
 	(see linkgit:git-config[1]).  To cancel `diff.orderFile`,
 	use `-O/dev/null`.
 
+CONFIGURATION
+-------------
+include::config/mergetool.txt[]
+
 TEMPORARY FILES
 ---------------
 `git mergetool` creates `*.orig` backup files while resolving merges.