diff --git a/docs-master/Config.md b/docs-master/Config.md index 1d101be18..867c6cc00 100644 --- a/docs-master/Config.md +++ b/docs-master/Config.md @@ -419,7 +419,9 @@ git: squashMergeMessage: Squash merge {{selectedRef}} into {{currentBranch}} # list of branches that are considered 'main' branches, used when displaying - # commits + # commits and for determining each branch's base. Lazygit prompts when a branch + # could be based on more than one of these (typical when one is regularly merged + # into another). mainBranches: - master - main diff --git a/pkg/config/app_config_test.go b/pkg/config/app_config_test.go index be97c2acb..a48c9d210 100644 --- a/pkg/config/app_config_test.go +++ b/pkg/config/app_config_test.go @@ -749,7 +749,7 @@ git: # The commit message to use for a squash merge commit. Can contain "{{selectedRef}}" and "{{currentBranch}}" placeholders. squashMergeMessage: Squash merge {{selectedRef}} into {{currentBranch}} - # list of branches that are considered 'main' branches, used when displaying commits + # list of branches that are considered 'main' branches, used when displaying commits and for determining each branch's base. Lazygit prompts when a branch could be based on more than one of these (typical when one is regularly merged into another). mainBranches: - master - main diff --git a/pkg/config/user_config.go b/pkg/config/user_config.go index 30ce0377d..639a466c2 100644 --- a/pkg/config/user_config.go +++ b/pkg/config/user_config.go @@ -304,7 +304,7 @@ type GitConfig struct { Commit CommitConfig `yaml:"commit"` // Config relating to merging Merging MergingConfig `yaml:"merging"` - // list of branches that are considered 'main' branches, used when displaying commits + // list of branches that are considered 'main' branches, used when displaying commits and for determining each branch's base. Lazygit prompts when a branch could be based on more than one of these (typical when one is regularly merged into another). MainBranches []string `yaml:"mainBranches" jsonschema:"uniqueItems=true"` // Prefix to use when skipping hooks. E.g. if set to 'WIP', then pre-commit hooks will be skipped when the commit message starts with 'WIP' SkipHookPrefix string `yaml:"skipHookPrefix"` diff --git a/schema-master/config.json b/schema-master/config.json index 82dbebb0b..77c3f11ac 100644 --- a/schema-master/config.json +++ b/schema-master/config.json @@ -337,7 +337,7 @@ }, "type": "array", "uniqueItems": true, - "description": "list of branches that are considered 'main' branches, used when displaying commits", + "description": "list of branches that are considered 'main' branches, used when displaying commits and for determining each branch's base. Lazygit prompts when a branch could be based on more than one of these (typical when one is regularly merged into another).", "default": [ "master", "main"