diff options
| author | Sagittarius-a <sagittarius-a@users.noreply.github.com> | 2020-11-23 22:07:16 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-11-23 22:07:16 +0100 |
| commit | 688f1b3457addedf10fe673e9329756d9bd2f6c9 (patch) | |
| tree | 8ae655bc3a71b3b0f934433f7f839b29683b301a /docs | |
| parent | cf297ff25d70678b446bfffaab3f5aa7e71c7fa6 (diff) | |
feat(git_branch): add remote branch name if different than local branch (#1915)
* feat(git_branch): add remote branch name if different than local branch
* feat(git_branch): Implement a more customizable remote branch
* feat(git_branch): Use more explicit API function name
* feat(git_branch): Remove forgotten draft documentation
* feat(git_branch): Set less verbose defaults
* feat(git_branch): Handle case to always display remote
* feat(git_branch): Fix error in rebase operation
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config/README.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index 122ca6e28..621b194a0 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -1025,6 +1025,7 @@ The `git_branch` module shows the active branch of the repo in your current dire | Option | Default | Description | | ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `always_show_remote`| `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | | `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. | | `symbol` | `" "` | A format string representing the symbol of git branch. | | `style` | `"bold purple"` | The style for the module. | @@ -1038,6 +1039,7 @@ The `git_branch` module shows the active branch of the repo in your current dire | Variable | Example | Description | | -------- | -------- | ---------------------------------------------------------------------------------------------------- | | branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). | +| remote | `master` | The remote branch name. | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | |