From e8f722cfe1123c32208da72ceaf56394044e1163 Mon Sep 17 00:00:00 2001 From: Ilya Grigoriev Date: Wed, 23 Oct 2024 01:54:00 -0700 Subject: [PATCH] docs config diff-editor: advertise Meld some more I think most people would benefit from trying both an internal and an external merge tool. I was also considering mentioning `kdiff3` or `diffedit3` more heavily. For `kdiff3`, I find its diff editing interface very confusing and I don't know of anybody who happily uses it as a diff editor. For `diffedit3`, I'm not very objective. --- docs/config.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/config.md b/docs/config.md index 96780a2a9..be1ca87ee 100644 --- a/docs/config.md +++ b/docs/config.md @@ -578,6 +578,15 @@ you can set the option to change the default. This requires that you have an appropriate tool installed, e.g. [Meld](https://meldmerge.org/) to use the `meld` diff editor. +**Suggestion:** If possible, it is recommended to try an external diff tool like +`meld` (see below for some other possibilities) for splitting commits and other +diff editing, in addition to the built-in diff editor. It is good to know the +capabilities of both. The built-in diff editor does not require external tools +to be available, is faster for tasks like picking hunks, and does not require +leaving the terminal. External tools give you the flexibility of picking out +portions of lines from the diff or even arbitrarily editing the text of the +files. + If `ui.diff-editor` is a string, e.g. `"meld"`, the arguments will be read from the following config keys.