mirrors/jj
1
0
Fork 1
mirror of https://github.com/martinvonz/jj.git synced 2024-12-27 06:27:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: make it clear ui. refers to a toml section

Browse source 
There was a question on Discord about why using Difftastic wasn't working as the
diff tool. The root cause was putting `ui.diff.tool` in the wrong toml section,
when the `ui.` component actually refers to the `[ui]` section itself.

This reads kind of weirdly too because _immediately_ after this, the alternative
option of using the `merge-tools` section is suggested; except it uses `[merge-
tools.<name>]` which makes it immediately clear it's a section on its own.

This simply these two examples more consistent with each other, by using `[ui]`
instead of `ui.` to make it clear `ui.` is a top-level section.

Signed-off-by: Austin Seipp <aseipp@pobox.com>
This commit is contained in:
Austin Seipp 2024-03-01 12:54:31 -06:00
parent 7ce25f8408
commit 415ae5c0f9
1 changed files with 3 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/config.md
View file

@ -172,10 +172,11 @@ If `ui.diff.tool` is set, the specified diff command will be called instead of
the internal diff function.
```toml
[ui]
# Use Difftastic by default
ui.diff.tool = ["difft", "--color=always", "$left", "$right"]
diff.tool = ["difft", "--color=always", "$left", "$right"]
# Use tool named "<name>" (see below)
ui.diff.tool = "<name>"
diff.tool = "<name>"
```
The external diff tool can also be enabled by `diff --tool <name>` argument.