diff options
| author | Bill <bill.risher99@gmail.com> | 2021-08-07 12:22:00 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-08-07 19:22:00 +0200 |
| commit | b2e2330cb05b64a87107c615d8c57fcf0b14ecf3 (patch) | |
| tree | 56ad4cf4a407cf0f37edae39232132d7a148e957 /docs | |
| parent | b7b7df98854b2d4ff9c5f2fdddc796449cdab908 (diff) | |
feat(git_status): added symbol for local repos up-to-date with remote. (#2945)
* git_status: added symbol for when local branch is up-to-date with upstream
* updated docs
* removed unused variable, moved location of config comment
* changed uptodate default to empty string, simplified and made safer
* added uptodate default line back into docstring
* fixed linting and formatting errors
* refactored uptodate to up_to_date, removed redundant else statement
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config/README.md | 26 |
1 files changed, 14 insertions, 12 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index f32c0b231..3fca0de57 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -1314,6 +1314,7 @@ current directory. | `ahead` | `"⇡"` | The format of `ahead` | | `behind` | `"⇣"` | The format of `behind` | | `diverged` | `"⇕"` | The format of `diverged` | +| `up_to_date` | `""` | The format of `up_to_date` | | `untracked` | `"?"` | The format of `untracked` | | `stashed` | `"$"` | The format of `stashed` | | `modified` | `"!"` | The format of `modified` | @@ -1327,18 +1328,18 @@ current directory. The following variables can be used in `format`: -| Variable | Description | -| -------------- | --------------------------------------------------------------------------------------------- | -| `all_status` | Shortcut for`$conflicted$stashed$deleted$renamed$modified$staged$untracked` | -| `ahead_behind` | Displays `diverged` `ahead` or `behind` format string based on the current status of the repo | -| `conflicted` | Displays `conflicted` when this branch has merge conflicts. | -| `untracked` | Displays `untracked` when there are untracked files in the working directory. | -| `stashed` | Displays `stashed` when a stash exists for the local repository. | -| `modified` | Displays `modified` when there are file modifications in the working directory. | -| `staged` | Displays `staged` when a new file has been added to the staging area. | -| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. | -| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | -| style\* | Mirrors the value of option `style` | +| Variable | Description | +| -------------- | ----------------------------------------------------------------------------------------------------------- | +| `all_status` | Shortcut for`$conflicted$stashed$deleted$renamed$modified$staged$untracked` | +| `ahead_behind` | Displays `diverged`, `ahead`, `behind` or `up_to_date` format string based on the current status of the repo. | +| `conflicted` | Displays `conflicted` when this branch has merge conflicts. | +| `untracked` | Displays `untracked` when there are untracked files in the working directory. | +| `stashed` | Displays `stashed` when a stash exists for the local repository. | +| `modified` | Displays `modified` when there are file modifications in the working directory. | +| `staged` | Displays `staged` when a new file has been added to the staging area. | +| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. | +| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | +| style\* | Mirrors the value of option `style` | \*: This variable can only be used as a part of a style string @@ -1365,6 +1366,7 @@ conflicted = "🏳" ahead = "🏎💨" behind = "😰" diverged = "😵" +up_to_date = "✓" untracked = "🤷" stashed = "📦" modified = "📝" |