Skip to content

Commit

Permalink
tigrc: document fallback for reference-format
Browse files Browse the repository at this point in the history
  • Loading branch information
arbrauns committed Mar 4, 2024
1 parent 9eebb5b commit 3f92521
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 6 deletions.
9 changes: 6 additions & 3 deletions doc/tigrc.5.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -179,9 +179,12 @@ The following variables can be set:
A space-separated string of format strings used for formatting reference
names. Wrap the name of the reference type with the characters you would
like to use for formatting, e.g. `[tag]` and `<remote>`. If no format is
specified for `local-tag`, the format for `tag` is used. Similarly, if no
format is specified for `tracked-remote` the `remote` format is used.
like to use for formatting, e.g. `[tag]` and `<remote>`.
- If no format is specified for `local-tag`, the format for `tag` is used.
- If no format is specified for `tracked-remote`, the format for `remote`
is used.
- If no format is specified for any other reference type, the format for
`branch` is used.
Prefix with `hide:` to not show that reference type, e.g. `hide:remote`.
Supported reference types are:
- head : The current HEAD.
Expand Down
8 changes: 5 additions & 3 deletions tigrc
Original file line number Diff line number Diff line change
Expand Up @@ -102,10 +102,12 @@ set truncation-delimiter = ~ # Character drawn for truncations, or "utf-8"
# - stash : The stash.
# - prefetch : Refs prefetched by `git maintenance`.
# - other : Any other reference.
# If no format is defined for `local-tag` then the one for `tag` is used.
# Similarly, `remote` is used if no `tracked-remote` format exists.
# Prefix with `hide:` to not show that reference type, e.g. `hide:remote`.
#
# Expects a space-separated list of format strings.
# - If no format is specified for `local-tag`, the format for `tag` is used.
# - If no format is specified for `tracked-remote`, the format for `remote` is used.
# - If no format is specified for any other reference type, the format for `branch` is used.
# Prefix with `hide:` to not show that reference type, e.g. `hide:remote`.
set reference-format = [branch] <tag> {remote} ~replace~

# Settings controlling how content is read from Git
Expand Down

0 comments on commit 3f92521

Please sign in to comment.