summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorcaojoshua <cao.joshua@yahoo.com>2021-05-31 23:23:33 -0700
committerJesse Duffield <jessedduffield@gmail.com>2021-06-05 10:58:09 +1000
commite7c657fba0dc27b188a9c4b91c35f3e3805d86cc (patch)
treeba396c7df7a12f37238fac6f403d9a9b51f0d3c4
parent60468d2e174656675b8058df519b6547bc7ca62e (diff)
Docs for EditCommand.
-rw-r--r--docs/Config.md18
-rw-r--r--pkg/commands/files.go2
2 files changed, 19 insertions, 1 deletions
diff --git a/docs/Config.md b/docs/Config.md
index c37747dbe..8b8897b06 100644
--- a/docs/Config.md
+++ b/docs/Config.md
@@ -61,6 +61,9 @@ git:
allBranchesLogCmd: 'git log --graph --all --color=always --abbrev-commit --decorate --date=relative --pretty=medium'
overrideGpg: false # prevents lazygit from spawning a separate process when using GPG
disableForcePushing: false
+os:
+ editCommand: '' # see EditCommand section
+ openCommand: # see OpenCommand section
refresher:
refreshInterval: 10 # file/submodule refresh interval in seconds
fetchInterval: 60 # re-fetch interval in seconds
@@ -214,6 +217,21 @@ os:
openCommand: 'open {{filename}}'
```
+### EditCommand
+Lazygit will run edit with the first non-empty command:
+1. config.yaml
+```yaml
+os:
+ editCommand:
+```
+2. $(git config core.editor)
+3. $GIT_EDITOR
+4. $VISUAL
+5. $EDITOR
+6. vi (if found through `which vi`)
+
+Lazygit will log an error if none of these commands are non-empty.
+
### Recommended Config Values
for users of VSCode
diff --git a/pkg/commands/files.go b/pkg/commands/files.go
index 8c86cfcf7..9e077a462 100644
--- a/pkg/commands/files.go
+++ b/pkg/commands/files.go
@@ -339,7 +339,7 @@ func (c *GitCommand) EditFileCmdStr(filename string) (string, error) {
}
}
if editor == "" {
- return "", errors.New("No editor defined in $GIT_EDITOR, $VISUAL, $EDITOR, or git config")
+ return "", errors.New("No editor defined in config file, $GIT_EDITOR, $VISUAL, $EDITOR, or git config")
}
return fmt.Sprintf("%s %s", editor, c.OSCommand.Quote(filename)), nil