summaryrefslogtreecommitdiffstats
path: root/git-for-each-ref.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2023-08-02 10:52:21 -0700
committerJunio C Hamano <gitster@pobox.com>2023-08-02 10:52:21 -0700
commit50a4df08cc234b607ebd8dfa811a68f23ba05fc4 (patch)
tree197d57d31eeb5c7772f4f87145f02b6beac12f1d /git-for-each-ref.txt
parent52617ff30d3f00e40ee3d80b05cedf3305e4db83 (diff)
downloadgit-htmldocs-50a4df08cc234b607ebd8dfa811a68f23ba05fc4.tar.gz
Autogenerated HTML docs for v2.41.0-494-g1b0a5
Diffstat (limited to 'git-for-each-ref.txt')
-rw-r--r--git-for-each-ref.txt23
1 files changed, 23 insertions, 0 deletions
diff --git a/git-for-each-ref.txt b/git-for-each-ref.txt
index d9588767a..11b2bc312 100644
--- a/git-for-each-ref.txt
+++ b/git-for-each-ref.txt
@@ -264,6 +264,29 @@ ahead-behind:<committish>::
commits ahead and behind, respectively, when comparing the output
ref to the `<committish>` specified in the format.
+describe[:options]::
+ A human-readable name, like linkgit:git-describe[1];
+ empty string for undescribable commits. The `describe` string may
+ be followed by a colon and one or more comma-separated options.
++
+--
+tags=<bool-value>;;
+ Instead of only considering annotated tags, consider
+ lightweight tags as well; see the corresponding option in
+ linkgit:git-describe[1] for details.
+abbrev=<number>;;
+ Use at least <number> hexadecimal digits; see the corresponding
+ option in linkgit:git-describe[1] for details.
+match=<pattern>;;
+ Only consider tags matching the given `glob(7)` pattern,
+ excluding the "refs/tags/" prefix; see the corresponding option
+ in linkgit:git-describe[1] for details.
+exclude=<pattern>;;
+ Do not consider tags matching the given `glob(7)` pattern,
+ excluding the "refs/tags/" prefix; see the corresponding option
+ in linkgit:git-describe[1] for details.
+--
+
In addition to the above, for commit and tag objects, the header
field names (`tree`, `parent`, `object`, `type`, and `tag`) can
be used to specify the value in the header field.