From 573320ba7dc089d4ab5e4210883d75fca17b6d0c Mon Sep 17 00:00:00 2001
From: iain barnett <helpful-iain@theprintedbird.com>
Date: Sun, 3 Jul 2022 14:16:01 +0900
Subject: [PATCH] Documented available config settings.

docs: Added config settings to documentation.
---
 docs/config.md | 88 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 88 insertions(+)
 create mode 100644 docs/config.md

diff --git a/docs/config.md b/docs/config.md
new file mode 100644
index 000000000..5dbb97c9b
--- /dev/null
+++ b/docs/config.md
@@ -0,0 +1,88 @@
+# Configuration
+
+These are the config settings available to jj/Jujutsu.
+
+The config settings are located at `~/.jjconfig.toml`.
+
+See the [TOML site](https://toml.io/en/) for more on syntax,
+but one thing to remember is that anything under a heading can be dotted
+e.g. `user.name = "YOUR NAME"` is equivalent to:
+
+    [user]
+      name = "YOUR NAME"
+
+Headings only need to be set once in the real config file but Jujutsu favours the dotted style in these instructions, if only because it's easier to write down in an unconfusing way. If you are confident with TOML then use whichever suits you in your config.
+
+The other thing to remember is that the value of a setting (the part to the 
+right of the `=` sign) should be surrounded in quotes if it's a string. 
+That's probably enough TOML to keep you out of trouble but the syntax guide is 
+very short if you ever need to check.
+
+
+## User settings
+
+    user.name = "YOUR NAME" 
+    user.email = "YOUR_EMAIL@example.com"
+
+Don't forget to change these to your own details!
+
+
+## UI settings
+
+### Colorizing output
+
+Possible values are `always`, `never` and `auto` (default: `auto`). 
+`auto` will use color only when writing to a terminal. 
+
+This setting overrides the `NO_COLOR` environment variable (if set).
+
+    ui.color = "never" # Turn off color
+
+
+### Editor
+
+The default editor is set via `ui.editor`,
+though there are several places to set it. 
+The priority is as follows (environment variables are marked with a `$`):
+
+`$JJ_EDITOR` > `ui.editor` > `$VISUAL` > `$EDITOR`
+
+Pico is the default editor in the absence of any other setting but you could 
+set it explicitly too.
+
+    ui.editor = "pico"
+
+To use NeoVim instead:
+
+    ui.editor = "nvim"
+
+For GUI editors you possibly need to use a `-w` or `--wait`. Some examples:
+
+    ui.editor = "code -w"       # VS Code
+    ui.editor = "bbedit -w"     # BBEdit
+    ui.editor = "subl -n -w"    # Sublime Text
+    ui.editor = "mate -w"       # TextMate
+    ui.editor = "'C:/Program Files/Notepad++/notepad++.exe' -multiInst -notabbar -nosession -noPlugin" # Notepad++
+    ui.editor = "idea --temp-project --wait"   #IntelliJ
+
+Obviously, you would only set one line, don't copy them all in!
+
+
+## Diffing
+
+This setting affects the tool used for editing diffs 
+(e.g. `jj split`, `jj amend -i`). 
+The default is `meld`.
+
+For example:
+
+    diff-editor = "vimdiff"
+
+When kdiff3 is set via:
+
+    diff-editor = "kdiff3"
+
+further settings are passed on via the following:
+
+    merge-tools.kdiff3.program = "kdiff3"
+    merge-tools.kdiff3.edit-args = ["--merge", "--cs", "CreateBakFiles=0"]