mirrors/jj
1
0
Fork 1
mirror of https://github.com/martinvonz/jj.git synced 2025-02-01 00:50:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

docs config diff-editor: clean up, change KDiff3 example to Meld

Browse source 
I don't think recommending KDIff3 for diff editing is good advice in
most cases (as opposed to merge conflict resolution, for which KDiff3 is
very good). OTOH, trying Meld for diff editing is a good idea for many
people.

Historically, this part of the docs uses KDiff3 because it was written
when `meld` was the default and `:builtin` did not exist.
This commit is contained in:
Ilya Grigoriev 2024-10-23 01:54:00 -07:00
parent 6a74199b4f
commit 4ecf75efc1
1 changed files with 27 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
docs/config.md
View file

@ -566,37 +566,47 @@ Obviously, you would only set one line, don't copy them all in!
## Editing diffs
The `ui.diff-editor` setting affects the tool used for editing diffs (e.g. `jj
split`, `jj squash -i`). The default is the special value `:builtin`, which
launches a built-in TUI tool (known as [scm-diff-editor]) to edit the diff in
your terminal.
The `ui.diff-editor` setting affects the default tool used for editing diffs
(e.g. `jj split`, `jj squash -i`). If it is not set, the special value
`:builtin` is used. It launches a built-in TUI tool (known as [scm-diff-editor])
to edit the diff in your terminal.
[scm-diff-editor]: https://github.com/arxanas/scm-record?tab=readme-ov-file#scm-diff-editor
You can try a different tool temporarily by doing e.g. `jj split --tool meld` or
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.
If `ui.diff-editor` is a string, e.g. `"meld"`, the arguments will be read from
the following config keys.
```toml
# merge-tools.meld.program = "meld" # Defaults to the name of the tool if not specified
merge-tools.meld.program = "/path/to/meld" # May be necessary if `meld` is not in the PATH
merge-tools.meld.edit-args = ["--newtab", "$left", "$right"]
```
`jj` makes the following substitutions:
- `$left` and `$right` are replaced with the paths to the left and right
directories to diff respectively.
If no arguments are specified, `["$left", "$right"]` are set by default.
- If no `edit-args` are specified, `["$left", "$right"]` are set by default.
For example:
Finally, `ui.diff-editor` can be a list that specifies a command and its arguments.
Some examples:
```toml
# Use merge-tools.kdiff3.edit-args
ui.diff-editor = "kdiff3"
# Use merge-tools.meld.edit-args
ui.diff-editor = "meld" # Or `kdiff3`, or `diffedit3`, ...
# Specify edit-args inline
ui.diff-editor = ["kdiff3", "--merge", "$left", "$right"]
ui.diff-editor = ["/path/to/binary", "--be-helpful", "$left", "$right"]
# Equivalent to ["binary", "$left", "$right"] arguments by default
ui.diff-editor = "binary"
```
If `ui.diff-editor` consists of a single word, e.g. `"kdiff3"`, the arguments
will be read from the following config keys.
```toml
# merge-tools.kdiff3.program = "kdiff3" # Defaults to the name of the tool if not specified
merge-tools.kdiff3.edit-args = [
"--merge", "--cs", "CreateBakFiles=0", "$left", "$right"]
```
### Experimental 3-pane diff editing