path: root/Documentation/git-branch.txt
diff options
authorMichael J Gruber <>2017-08-18 14:51:22 (GMT)
committerJunio C Hamano <>2017-08-18 16:54:09 (GMT)
commite4933cee53bce14ae040d02d0febd678c5686dde (patch)
treecdb74d59fc1ebe5ac13037da5607b05157f57070 /Documentation/git-branch.txt
parent4d7268b888d7bb6d675340ec676e4239739d0f6d (diff)
Documentation: use proper wording for ref format strings
Various commands list refs and allow to use a format string for the output that interpolates from the ref as well as the object it points at (for-each-ref; branch and tag in list mode). Currently, the documentation talks about interpolating from the object. This is confusing because a ref points to an object but not vice versa, so the object cannot possible know %(refname), for example. Thus, this is wrong independent of refs being objects (one day, maybe) or not. Change the wording to make this clearer (and distinguish it from formats for the log family). Signed-off-by: Michael J Gruber <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/git-branch.txt')
1 files changed, 2 insertions, 2 deletions
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
index 81bd0a7..d0b3358 100644
--- a/Documentation/git-branch.txt
+++ b/Documentation/git-branch.txt
@@ -267,8 +267,8 @@ start-point is either a local or remote-tracking branch.
Only list branches of the given object.
--format <format>::
- A string that interpolates `%(fieldname)` from the object
- pointed at by a ref being shown. The format is the same as
+ A string that interpolates `%(fieldname)` from a branch ref being shown
+ and the object it points at. The format is the same as
that of linkgit:git-for-each-ref[1].