1PRETTY FORMATS 2-------------- 3 4If the commit is a merge, and if the pretty-format 5is not 'oneline', 'email' or 'raw', an additional line is 6inserted before the 'Author:' line. This line begins with 7"Merge: " and the sha1s of ancestral commits are printed, 8separated by spaces. Note that the listed commits may not 9necessarily be the list of the *direct* parent commits if you 10have limited your view of history: for example, if you are 11only interested in changes related to a certain directory or 12file. 13 14There are several built-in formats, and you can define 15additional formats by setting a pretty.<name> 16config option to either another format name, or a 17'format:' string, as described below (see 18linkgit:git-config[1]). Here are the details of the 19built-in formats: 20 21* 'oneline' 22 23 <sha1> <title line> 24+ 25This is designed to be as compact as possible. 26 27* 'short' 28 29 commit <sha1> 30 Author: <author> 31 32 <title line> 33 34* 'medium' 35 36 commit <sha1> 37 Author: <author> 38 Date: <author date> 39 40 <title line> 41 42 <full commit message> 43 44* 'full' 45 46 commit <sha1> 47 Author: <author> 48 Commit: <committer> 49 50 <title line> 51 52 <full commit message> 53 54* 'fuller' 55 56 commit <sha1> 57 Author: <author> 58 AuthorDate: <author date> 59 Commit: <committer> 60 CommitDate: <committer date> 61 62 <title line> 63 64 <full commit message> 65 66* 'email' 67 68 From <sha1> <date> 69 From: <author> 70 Date: <author date> 71 Subject: [PATCH] <title line> 72 73 <full commit message> 74 75* 'raw' 76+ 77The 'raw' format shows the entire commit exactly as 78stored in the commit object. Notably, the SHA-1s are 79displayed in full, regardless of whether --abbrev or 80--no-abbrev are used, and 'parents' information show the 81true parent commits, without taking grafts or history 82simplification into account. Note that this format affects the way 83commits are displayed, but not the way the diff is shown e.g. with 84`git log --raw`. To get full object names in a raw diff format, 85use `--no-abbrev`. 86 87* 'format:<string>' 88+ 89The 'format:<string>' format allows you to specify which information 90you want to show. It works a little bit like printf format, 91with the notable exception that you get a newline with '%n' 92instead of '\n'. 93+ 94E.g, 'format:"The author of %h was %an, %ar%nThe title was >>%s<<%n"' 95would show something like this: 96+ 97------- 98The author of fe6e0ee was Junio C Hamano, 23 hours ago 99The title was >>t4119: test autocomputing -p<n> for traditional diff input.<< 100 101------- 102+ 103The placeholders are: 104 105- Placeholders that expand to a single literal character: 106'%n':: newline 107'%%':: a raw '%' 108'%x00':: print a byte from a hex code 109 110- Placeholders that affect formatting of later placeholders: 111'%Cred':: switch color to red 112'%Cgreen':: switch color to green 113'%Cblue':: switch color to blue 114'%Creset':: reset color 115'%C(...)':: color specification, as described under Values in the 116 "CONFIGURATION FILE" section of linkgit:git-config[1]. By 117 default, colors are shown only when enabled for log output 118 (by `color.diff`, `color.ui`, or `--color`, and respecting 119 the `auto` settings of the former if we are going to a 120 terminal). `%C(auto,...)` is accepted as a historical 121 synonym for the default (e.g., `%C(auto,red)`). Specifying 122 `%C(always,...) will show the colors even when color is 123 not otherwise enabled (though consider just using 124 `--color=always` to enable color for the whole output, 125 including this format and anything else git might color). 126 `auto` alone (i.e. `%C(auto)`) will turn on auto coloring 127 on the next placeholders until the color is switched 128 again. 129'%m':: left (`<`), right (`>`) or boundary (`-`) mark 130'%w([<w>[,<i1>[,<i2>]]])':: switch line wrapping, like the -w option of 131 linkgit:git-shortlog[1]. 132'%<(<N>[,trunc|ltrunc|mtrunc])':: make the next placeholder take at 133 least N columns, padding spaces on 134 the right if necessary. Optionally 135 truncate at the beginning (ltrunc), 136 the middle (mtrunc) or the end 137 (trunc) if the output is longer than 138 N columns. Note that truncating 139 only works correctly with N >= 2. 140'%<|(<N>)':: make the next placeholder take at least until Nth 141 columns, padding spaces on the right if necessary 142'%>(<N>)', '%>|(<N>)':: similar to '%<(<N>)', '%<|(<N>)' respectively, 143 but padding spaces on the left 144'%>>(<N>)', '%>>|(<N>)':: similar to '%>(<N>)', '%>|(<N>)' 145 respectively, except that if the next 146 placeholder takes more spaces than given and 147 there are spaces on its left, use those 148 spaces 149'%><(<N>)', '%><|(<N>)':: similar to '%<(<N>)', '%<|(<N>)' 150 respectively, but padding both sides 151 (i.e. the text is centered) 152 153- Placeholders that expand to information extracted from the commit: 154'%H':: commit hash 155'%h':: abbreviated commit hash 156'%T':: tree hash 157'%t':: abbreviated tree hash 158'%P':: parent hashes 159'%p':: abbreviated parent hashes 160'%an':: author name 161'%aN':: author name (respecting .mailmap, see linkgit:git-shortlog[1] 162 or linkgit:git-blame[1]) 163'%ae':: author email 164'%aE':: author email (respecting .mailmap, see linkgit:git-shortlog[1] 165 or linkgit:git-blame[1]) 166'%ad':: author date (format respects --date= option) 167'%aD':: author date, RFC2822 style 168'%ar':: author date, relative 169'%at':: author date, UNIX timestamp 170'%ai':: author date, ISO 8601-like format 171'%aI':: author date, strict ISO 8601 format 172'%cn':: committer name 173'%cN':: committer name (respecting .mailmap, see 174 linkgit:git-shortlog[1] or linkgit:git-blame[1]) 175'%ce':: committer email 176'%cE':: committer email (respecting .mailmap, see 177 linkgit:git-shortlog[1] or linkgit:git-blame[1]) 178'%cd':: committer date (format respects --date= option) 179'%cD':: committer date, RFC2822 style 180'%cr':: committer date, relative 181'%ct':: committer date, UNIX timestamp 182'%ci':: committer date, ISO 8601-like format 183'%cI':: committer date, strict ISO 8601 format 184'%d':: ref names, like the --decorate option of linkgit:git-log[1] 185'%D':: ref names without the " (", ")" wrapping. 186'%e':: encoding 187'%s':: subject 188'%f':: sanitized subject line, suitable for a filename 189'%b':: body 190'%B':: raw body (unwrapped subject and body) 191ifndef::git-rev-list[] 192'%N':: commit notes 193endif::git-rev-list[] 194'%GG':: raw verification message from GPG for a signed commit 195'%G?':: show "G" for a good (valid) signature, 196 "B" for a bad signature, 197 "U" for a good signature with unknown validity, 198 "X" for a good signature that has expired, 199 "Y" for a good signature made by an expired key, 200 "R" for a good signature made by a revoked key, 201 "E" if the signature cannot be checked (e.g. missing key) 202 and "N" for no signature 203'%GS':: show the name of the signer for a signed commit 204'%GK':: show the key used to sign a signed commit 205'%GF':: show the fingerprint of the key used to sign a signed commit 206'%GP':: show the fingerprint of the primary key whose subkey was used 207 to sign a signed commit 208'%gD':: reflog selector, e.g., `refs/stash@{1}` or `refs/stash@{2 209 minutes ago`}; the format follows the rules described for the 210 `-g` option. The portion before the `@` is the refname as 211 given on the command line (so `git log -g refs/heads/master` 212 would yield `refs/heads/master@{0}`). 213'%gd':: shortened reflog selector; same as `%gD`, but the refname 214 portion is shortened for human readability (so 215 `refs/heads/master` becomes just `master`). 216'%gn':: reflog identity name 217'%gN':: reflog identity name (respecting .mailmap, see 218 linkgit:git-shortlog[1] or linkgit:git-blame[1]) 219'%ge':: reflog identity email 220'%gE':: reflog identity email (respecting .mailmap, see 221 linkgit:git-shortlog[1] or linkgit:git-blame[1]) 222'%gs':: reflog subject 223'%(trailers[:options])':: display the trailers of the body as 224 interpreted by 225 linkgit:git-interpret-trailers[1]. The 226 `trailers` string may be followed by a colon 227 and zero or more comma-separated options: 228** 'only': omit non-trailer lines from the trailer block. 229** 'unfold': make it behave as if interpret-trailer's `--unfold` 230 option was given. E.g., `%(trailers:only,unfold)` unfolds and 231 shows all trailer lines. 232 233NOTE: Some placeholders may depend on other options given to the 234revision traversal engine. For example, the `%g*` reflog options will 235insert an empty string unless we are traversing reflog entries (e.g., by 236`git log -g`). The `%d` and `%D` placeholders will use the "short" 237decoration format if `--decorate` was not already provided on the command 238line. 239 240If you add a `+` (plus sign) after '%' of a placeholder, a line-feed 241is inserted immediately before the expansion if and only if the 242placeholder expands to a non-empty string. 243 244If you add a `-` (minus sign) after '%' of a placeholder, all consecutive 245line-feeds immediately preceding the expansion are deleted if and only if the 246placeholder expands to an empty string. 247 248If you add a ` ` (space) after '%' of a placeholder, a space 249is inserted immediately before the expansion if and only if the 250placeholder expands to a non-empty string. 251 252* 'tformat:' 253+ 254The 'tformat:' format works exactly like 'format:', except that it 255provides "terminator" semantics instead of "separator" semantics. In 256other words, each commit has the message terminator character (usually a 257newline) appended, rather than a separator placed between entries. 258This means that the final entry of a single-line format will be properly 259terminated with a new line, just as the "oneline" format does. 260For example: 261+ 262--------------------- 263$ git log -2 --pretty=format:%h 4da45bef \ 264 | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/' 2654da45be 2667134973 -- NO NEWLINE 267 268$ git log -2 --pretty=tformat:%h 4da45bef \ 269 | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/' 2704da45be 2717134973 272--------------------- 273+ 274In addition, any unrecognized string that has a `%` in it is interpreted 275as if it has `tformat:` in front of it. For example, these two are 276equivalent: 277+ 278--------------------- 279$ git log -2 --pretty=tformat:%h 4da45bef 280$ git log -2 --pretty=%h 4da45bef 281---------------------