summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorJesse Duffield <jessedduffield@gmail.com>2021-06-05 10:04:35 +1000
committerJesse Duffield <jessedduffield@gmail.com>2021-06-05 10:58:09 +1000
commit0df02dacc2c8ad970664d4bbcded1efeeebac3a9 (patch)
treed4de2f0e17c92529b8774b581d70c17cc1505525 /docs
parent3258c24fb35403524dd74feffc9669a639716424 (diff)
minor changes
Diffstat (limited to 'docs')
-rw-r--r--docs/Config.md22
1 files changed, 13 insertions, 9 deletions
diff --git a/docs/Config.md b/docs/Config.md
index 150961442..3dca4dc9d 100644
--- a/docs/Config.md
+++ b/docs/Config.md
@@ -62,8 +62,8 @@ git:
overrideGpg: false # prevents lazygit from spawning a separate process when using GPG
disableForcePushing: false
os:
- editCommand: '' # see EditCommand section
- openCommand: # see OpenCommand section
+ editCommand: '' # see 'Configuring File Editing' section
+ openCommand: ''
refresher:
refreshInterval: 10 # file/submodule refresh interval in seconds
fetchInterval: 60 # re-fetch interval in seconds
@@ -218,17 +218,21 @@ os:
```
### Configuring File Editing
-Lazygit will run edit with the first set option:
+
+Lazygit will edit a file with the first set editor in the following:
+
1. config.yaml
+
```yaml
os:
- editCommand:
+ editCommand: 'vim' # as an example
```
-2. $(git config core.editor)
-3. $GIT_EDITOR
-4. $VISUAL
-5. $EDITOR
-6. $(which vi)
+
+2. \$(git config core.editor)
+3. \$GIT_EDITOR
+4. \$VISUAL
+5. \$EDITOR
+6. \$(which vi)
Lazygit will log an error if none of these options are set.