for-each-ref: add ahead-behind format atom

[thirdparty/git.git] / Documentation / git-for-each-ref.txt

diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index ccdc2911bb9a3384941991cdeb87a07574949d86..0713e49b4992e270455a02f5fd3cb93089dc0809 100644 (file)
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -222,6 +222,11 @@ worktreepath::
        out, if it is checked out in any linked worktree. Empty string
        otherwise.
 
+ahead-behind:<committish>::
+       Two integers, separated by a space, demonstrating the number of
+       commits ahead and behind, respectively, when comparing the output
+       ref to the `<committish>` specified in the format.
+
 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.