1
0
mirror of https://github.com/jesseduffield/lazygit.git synced 2025-06-04 23:37:41 +02:00

Add comments with more information

This will be useful in the next commit when these start to show up in the
generated Config.md.
This commit is contained in:
Stefan Haller 2025-03-22 12:32:10 +01:00
parent a51bf12661
commit 0c9154ca9d
2 changed files with 4 additions and 3 deletions

View File

@ -24,6 +24,7 @@ type UserConfig struct {
// If true, don't display introductory popups upon opening Lazygit. // If true, don't display introductory popups upon opening Lazygit.
DisableStartupPopups bool `yaml:"disableStartupPopups"` DisableStartupPopups bool `yaml:"disableStartupPopups"`
// User-configured commands that can be invoked from within Lazygit // User-configured commands that can be invoked from within Lazygit
// See https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md
CustomCommands []CustomCommand `yaml:"customCommands" jsonschema:"uniqueItems=true"` CustomCommands []CustomCommand `yaml:"customCommands" jsonschema:"uniqueItems=true"`
// See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls // See https://github.com/jesseduffield/lazygit/blob/master/docs/Config.md#custom-pull-request-urls
Services map[string]string `yaml:"services"` Services map[string]string `yaml:"services"`
@ -252,7 +253,7 @@ type GitConfig struct {
// Command used to display git log of all branches in the main window. // Command used to display git log of all branches in the main window.
// Deprecated: Use `allBranchesLogCmds` instead. // Deprecated: Use `allBranchesLogCmds` instead.
AllBranchesLogCmd string `yaml:"allBranchesLogCmd"` AllBranchesLogCmd string `yaml:"allBranchesLogCmd"`
// Commands used to display git log of all branches in the main window, they will be cycled in order of appearance // Commands used to display git log of all branches in the main window, they will be cycled in order of appearance (array of strings)
AllBranchesLogCmds []string `yaml:"allBranchesLogCmds"` AllBranchesLogCmds []string `yaml:"allBranchesLogCmds"`
// If true, do not spawn a separate process when using GPG // If true, do not spawn a separate process when using GPG
OverrideGpg bool `yaml:"overrideGpg"` OverrideGpg bool `yaml:"overrideGpg"`

View File

@ -329,7 +329,7 @@
"type": "string" "type": "string"
}, },
"type": "array", "type": "array",
"description": "Commands used to display git log of all branches in the main window, they will be cycled in order of appearance" "description": "Commands used to display git log of all branches in the main window, they will be cycled in order of appearance (array of strings)"
}, },
"overrideGpg": { "overrideGpg": {
"type": "boolean", "type": "boolean",
@ -1838,7 +1838,7 @@
}, },
"type": "array", "type": "array",
"uniqueItems": true, "uniqueItems": true,
"description": "User-configured commands that can be invoked from within Lazygit" "description": "User-configured commands that can be invoked from within Lazygit\nSee https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md"
}, },
"services": { "services": {
"additionalProperties": { "additionalProperties": {