From 415ae5c0f9ed4d45df564a4aca6d327485a445bf Mon Sep 17 00:00:00 2001 From: Austin Seipp Date: Fri, 1 Mar 2024 12:54:31 -0600 Subject: [PATCH] docs: make it clear `ui.` refers to a toml section 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.]` 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 --- docs/config.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/config.md b/docs/config.md index 04eeda590..eaa074bcb 100644 --- a/docs/config.md +++ b/docs/config.md @@ -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 "" (see below) -ui.diff.tool = "" +diff.tool = "" ``` The external diff tool can also be enabled by `diff --tool ` argument.