Skip to content

Commit ef1da6f

Browse files
authored
reword documentation for git.autoForwardBranches (#4545)
- **PR Description** The wording "lazygit will automatically forward branches to their upstream after fetching" could be interpreted to mean that lazygit automatically pushes branches, rather than operating locally. Edited to make the behavior more clear. - **Please check if the PR fulfills these requirements** * [x] Cheatsheets are up-to-date (run `go generate ./...`) * [x] Code has been formatted (see [here](https://github.com/jesseduffield/lazygit/blob/master/CONTRIBUTING.md#code-formatting)) * [ ] Tests have been added/updated (see [here](https://github.com/jesseduffield/lazygit/blob/master/pkg/integration/README.md) for the integration test guide) * [ ] Text is internationalised (see [here](https://github.com/jesseduffield/lazygit/blob/master/CONTRIBUTING.md#internationalisation)) * [ ] If a new UserConfig entry was added, make sure it can be hot-reloaded (see [here](https://github.com/jesseduffield/lazygit/blob/master/docs/dev/Codebase_Guide.md#using-userconfig)) * [x] Docs have been updated if necessary * [x] You've read through your own file changes for silly mistakes etc <!-- Be sure to name your PR with an imperative e.g. 'Add worktrees view' see https://github.com/jesseduffield/lazygit/releases/tag/v0.40.0 for examples -->
2 parents e6bd9d0 + 4e497ee commit ef1da6f

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

docs/Config.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -337,7 +337,7 @@ git:
337337
# If true, periodically refresh files and submodules
338338
autoRefresh: true
339339

340-
# If not "none", lazygit will automatically forward branches to their upstream after fetching. Applies to branches that are not the currently checked out branch, and only to those that are strictly behind their upstream (as opposed to diverged).
340+
# If not "none", lazygit will automatically fast-forward local branches to match their upstream after fetching. Applies to branches that are not the currently checked out branch, and only to those that are strictly behind their upstream (as opposed to diverged).
341341
# Possible values: 'none' | 'onlyMainBranches' | 'allBranches'
342342
autoForwardBranches: onlyMainBranches
343343

pkg/config/user_config.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ type GitConfig struct {
244244
AutoFetch bool `yaml:"autoFetch"`
245245
// If true, periodically refresh files and submodules
246246
AutoRefresh bool `yaml:"autoRefresh"`
247-
// If not "none", lazygit will automatically forward branches to their upstream after fetching. Applies to branches that are not the currently checked out branch, and only to those that are strictly behind their upstream (as opposed to diverged).
247+
// If not "none", lazygit will automatically fast-forward local branches to match their upstream after fetching. Applies to branches that are not the currently checked out branch, and only to those that are strictly behind their upstream (as opposed to diverged).
248248
// Possible values: 'none' | 'onlyMainBranches' | 'allBranches'
249249
AutoForwardBranches string `yaml:"autoForwardBranches" jsonschema:"enum=none,enum=onlyMainBranches,enum=allBranches"`
250250
// If true, pass the --all arg to git fetch

schema/config.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -331,7 +331,7 @@
331331
"onlyMainBranches",
332332
"allBranches"
333333
],
334-
"description": "If not \"none\", lazygit will automatically forward branches to their upstream after fetching. Applies to branches that are not the currently checked out branch, and only to those that are strictly behind their upstream (as opposed to diverged).\nPossible values: 'none' | 'onlyMainBranches' | 'allBranches'",
334+
"description": "If not \"none\", lazygit will automatically fast-forward local branches to match their upstream after fetching. Applies to branches that are not the currently checked out branch, and only to those that are strictly behind their upstream (as opposed to diverged).\nPossible values: 'none' | 'onlyMainBranches' | 'allBranches'",
335335
"default": "onlyMainBranches"
336336
},
337337
"fetchAll": {

0 commit comments

Comments
 (0)