doc/pretty-formats: explain shortening of %gd
The actual shortening rules aren't that interesting and probably not worth getting into (I gloss over them here as "shortened for human readability"). But the fact that %gD shows whatever you gave on the command line is subtle and worth mentioning. Since most people will feed a shortened refname in the first place, it otherwise makes it hard to understand the difference between the two. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jeff King committed
Jul 22, 2016 at 15:51 UTC
d38c7b2c2ce0116215eb05e11d442e9d03b887f4
1 file changed
+6
-3
Documentation/pretty-formats.txt
+6
-3
@@ -149,9 +149,12 @@ endif::git-rev-list[]
149
- '%GK': show the key used to sign a signed commit
150
- '%gD': reflog selector, e.g., `refs/stash@{1}` or
151
`refs/stash@{2 minutes ago`}; the format follows the rules described
152
- for the `-g` option
153
-- '%gd': shortened reflog selector, e.g., `stash@{1}` or
154
- `stash@{2 minutes ago}`
152
+ for the `-g` option. The portion before the `@` is the refname as
153
+ given on the command line (so `git log -g refs/heads/master` would
154
+ yield `refs/heads/master@{0}`).
155
+- '%gd': shortened reflog selector; same as `%gD`, but the refname
156
+ portion is shortened for human readability (so `refs/heads/master`
157
+ becomes just `master`).
158
- '%gn': reflog identity name
159
- '%gN': reflog identity name (respecting .mailmap, see
160
linkgit:git-shortlog[1] or linkgit:git-blame[1])