Jakub Narebski | 331b51d | 2007-05-14 01:25:45 +0200 | [diff] [blame] | 1 | PRETTY FORMATS |
| 2 | -------------- |
Chris Riddoch | 5d1faf8 | 2006-11-21 16:49:15 -0700 | [diff] [blame] | 3 | |
Jakub Narebski | 331b51d | 2007-05-14 01:25:45 +0200 | [diff] [blame] | 4 | If the commit is a merge, and if the pretty-format |
| 5 | is not 'oneline', 'email' or 'raw', an additional line is |
| 6 | inserted before the 'Author:' line. This line begins with |
| 7 | "Merge: " and the sha1s of ancestral commits are printed, |
| 8 | separated by spaces. Note that the listed commits may not |
| 9 | necessarily be the list of the *direct* parent commits if you |
| 10 | have limited your view of history: for example, if you are |
| 11 | only interested in changes related to a certain directory or |
| 12 | file. |
Chris Riddoch | 5d1faf8 | 2006-11-21 16:49:15 -0700 | [diff] [blame] | 13 | |
Jakub Narebski | 331b51d | 2007-05-14 01:25:45 +0200 | [diff] [blame] | 14 | Here are some additional details for each format: |
| 15 | |
| 16 | * 'oneline' |
Chris Riddoch | 5d1faf8 | 2006-11-21 16:49:15 -0700 | [diff] [blame] | 17 | |
| 18 | <sha1> <title line> |
| 19 | + |
| 20 | This is designed to be as compact as possible. |
| 21 | |
Jakub Narebski | 331b51d | 2007-05-14 01:25:45 +0200 | [diff] [blame] | 22 | * 'short' |
Chris Riddoch | 5d1faf8 | 2006-11-21 16:49:15 -0700 | [diff] [blame] | 23 | |
| 24 | commit <sha1> |
| 25 | Author: <author> |
| 26 | |
| 27 | <title line> |
| 28 | |
Jakub Narebski | 331b51d | 2007-05-14 01:25:45 +0200 | [diff] [blame] | 29 | * 'medium' |
Chris Riddoch | 5d1faf8 | 2006-11-21 16:49:15 -0700 | [diff] [blame] | 30 | |
| 31 | commit <sha1> |
| 32 | Author: <author> |
Markus Heidelberg | ec9f0ea | 2008-12-19 13:14:52 +0100 | [diff] [blame] | 33 | Date: <author date> |
Chris Riddoch | 5d1faf8 | 2006-11-21 16:49:15 -0700 | [diff] [blame] | 34 | |
| 35 | <title line> |
| 36 | |
| 37 | <full commit message> |
| 38 | |
Jakub Narebski | 331b51d | 2007-05-14 01:25:45 +0200 | [diff] [blame] | 39 | * 'full' |
Chris Riddoch | 5d1faf8 | 2006-11-21 16:49:15 -0700 | [diff] [blame] | 40 | |
| 41 | commit <sha1> |
| 42 | Author: <author> |
| 43 | Commit: <committer> |
| 44 | |
| 45 | <title line> |
| 46 | |
| 47 | <full commit message> |
| 48 | |
Jakub Narebski | 331b51d | 2007-05-14 01:25:45 +0200 | [diff] [blame] | 49 | * 'fuller' |
Chris Riddoch | 5d1faf8 | 2006-11-21 16:49:15 -0700 | [diff] [blame] | 50 | |
| 51 | commit <sha1> |
Markus Heidelberg | ec9f0ea | 2008-12-19 13:14:52 +0100 | [diff] [blame] | 52 | Author: <author> |
Nikolaus Schulz | 2b2da68 | 2008-07-05 02:00:13 +0200 | [diff] [blame] | 53 | AuthorDate: <author date> |
Markus Heidelberg | ec9f0ea | 2008-12-19 13:14:52 +0100 | [diff] [blame] | 54 | Commit: <committer> |
Nikolaus Schulz | 2b2da68 | 2008-07-05 02:00:13 +0200 | [diff] [blame] | 55 | CommitDate: <committer date> |
Chris Riddoch | 5d1faf8 | 2006-11-21 16:49:15 -0700 | [diff] [blame] | 56 | |
| 57 | <title line> |
| 58 | |
| 59 | <full commit message> |
| 60 | |
Jakub Narebski | 331b51d | 2007-05-14 01:25:45 +0200 | [diff] [blame] | 61 | * 'email' |
Chris Riddoch | 5d1faf8 | 2006-11-21 16:49:15 -0700 | [diff] [blame] | 62 | |
| 63 | From <sha1> <date> |
| 64 | From: <author> |
Nikolaus Schulz | 2b2da68 | 2008-07-05 02:00:13 +0200 | [diff] [blame] | 65 | Date: <author date> |
Chris Riddoch | 5d1faf8 | 2006-11-21 16:49:15 -0700 | [diff] [blame] | 66 | Subject: [PATCH] <title line> |
| 67 | |
Jakub Narebski | 331b51d | 2007-05-14 01:25:45 +0200 | [diff] [blame] | 68 | <full commit message> |
Chris Riddoch | 5d1faf8 | 2006-11-21 16:49:15 -0700 | [diff] [blame] | 69 | |
Jakub Narebski | 331b51d | 2007-05-14 01:25:45 +0200 | [diff] [blame] | 70 | * 'raw' |
Chris Riddoch | 5d1faf8 | 2006-11-21 16:49:15 -0700 | [diff] [blame] | 71 | + |
| 72 | The 'raw' format shows the entire commit exactly as |
| 73 | stored in the commit object. Notably, the SHA1s are |
| 74 | displayed in full, regardless of whether --abbrev or |
| 75 | --no-abbrev are used, and 'parents' information show the |
| 76 | true parent commits, without taking grafts nor history |
| 77 | simplification into account. |
Junio C Hamano | 7cbcf4d | 2006-12-30 11:59:08 -0800 | [diff] [blame] | 78 | |
Jakub Narebski | 331b51d | 2007-05-14 01:25:45 +0200 | [diff] [blame] | 79 | * 'format:' |
Johannes Schindelin | e52a5de | 2007-02-23 01:35:03 +0100 | [diff] [blame] | 80 | + |
| 81 | The 'format:' format allows you to specify which information |
| 82 | you want to show. It works a little bit like printf format, |
| 83 | with the notable exception that you get a newline with '%n' |
| 84 | instead of '\n'. |
Jakub Narebski | 331b51d | 2007-05-14 01:25:45 +0200 | [diff] [blame] | 85 | + |
| 86 | E.g, 'format:"The author of %h was %an, %ar%nThe title was >>%s<<%n"' |
Johannes Schindelin | e52a5de | 2007-02-23 01:35:03 +0100 | [diff] [blame] | 87 | would show something like this: |
Jakub Narebski | 331b51d | 2007-05-14 01:25:45 +0200 | [diff] [blame] | 88 | + |
| 89 | ------- |
Johannes Schindelin | e52a5de | 2007-02-23 01:35:03 +0100 | [diff] [blame] | 90 | The author of fe6e0ee was Junio C Hamano, 23 hours ago |
| 91 | The title was >>t4119: test autocomputing -p<n> for traditional diff input.<< |
| 92 | |
Jakub Narebski | 331b51d | 2007-05-14 01:25:45 +0200 | [diff] [blame] | 93 | -------- |
| 94 | + |
Johannes Schindelin | e52a5de | 2007-02-23 01:35:03 +0100 | [diff] [blame] | 95 | The placeholders are: |
| 96 | |
| 97 | - '%H': commit hash |
| 98 | - '%h': abbreviated commit hash |
| 99 | - '%T': tree hash |
| 100 | - '%t': abbreviated tree hash |
| 101 | - '%P': parent hashes |
| 102 | - '%p': abbreviated parent hashes |
| 103 | - '%an': author name |
Marius Storm-Olsen | 7d48e9e | 2009-02-08 15:34:31 +0100 | [diff] [blame] | 104 | - '%aN': author name (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1]) |
Johannes Schindelin | e52a5de | 2007-02-23 01:35:03 +0100 | [diff] [blame] | 105 | - '%ae': author email |
Marius Storm-Olsen | 7d48e9e | 2009-02-08 15:34:31 +0100 | [diff] [blame] | 106 | - '%aE': author email (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1]) |
Jeff King | d36f867 | 2008-08-28 20:54:59 -0400 | [diff] [blame] | 107 | - '%ad': author date (format respects --date= option) |
Johannes Schindelin | e52a5de | 2007-02-23 01:35:03 +0100 | [diff] [blame] | 108 | - '%aD': author date, RFC2822 style |
| 109 | - '%ar': author date, relative |
| 110 | - '%at': author date, UNIX timestamp |
Robin Rosenberg | ee8f838 | 2007-07-14 01:00:42 +0200 | [diff] [blame] | 111 | - '%ai': author date, ISO 8601 format |
Johannes Schindelin | e52a5de | 2007-02-23 01:35:03 +0100 | [diff] [blame] | 112 | - '%cn': committer name |
Marius Storm-Olsen | 7d48e9e | 2009-02-08 15:34:31 +0100 | [diff] [blame] | 113 | - '%cN': committer name (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1]) |
Johannes Schindelin | e52a5de | 2007-02-23 01:35:03 +0100 | [diff] [blame] | 114 | - '%ce': committer email |
Marius Storm-Olsen | 7d48e9e | 2009-02-08 15:34:31 +0100 | [diff] [blame] | 115 | - '%cE': committer email (respecting .mailmap, see linkgit:git-shortlog[1] or linkgit:git-blame[1]) |
Johannes Schindelin | e52a5de | 2007-02-23 01:35:03 +0100 | [diff] [blame] | 116 | - '%cd': committer date |
| 117 | - '%cD': committer date, RFC2822 style |
| 118 | - '%cr': committer date, relative |
| 119 | - '%ct': committer date, UNIX timestamp |
Robin Rosenberg | ee8f838 | 2007-07-14 01:00:42 +0200 | [diff] [blame] | 120 | - '%ci': committer date, ISO 8601 format |
René Scharfe | 3b3d443 | 2008-09-04 23:40:03 +0200 | [diff] [blame] | 121 | - '%d': ref names, like the --decorate option of linkgit:git-log[1] |
Johannes Schindelin | e52a5de | 2007-02-23 01:35:03 +0100 | [diff] [blame] | 122 | - '%e': encoding |
| 123 | - '%s': subject |
Stephen Boyd | 46d164b | 2009-03-22 19:14:01 -0700 | [diff] [blame] | 124 | - '%f': sanitized subject line, suitable for a filename |
Johannes Schindelin | e52a5de | 2007-02-23 01:35:03 +0100 | [diff] [blame] | 125 | - '%b': body |
Johannes Schindelin | 8b208f0 | 2009-10-09 12:22:05 +0200 | [diff] [blame] | 126 | - '%N': commit notes |
Thomas Rast | 8f8f547 | 2009-10-19 17:48:10 +0200 | [diff] [blame] | 127 | - '%gD': reflog selector, e.g., `refs/stash@\{1\}` |
| 128 | - '%gd': shortened reflog selector, e.g., `stash@\{1\}` |
| 129 | - '%gs': reflog subject |
Johannes Schindelin | e52a5de | 2007-02-23 01:35:03 +0100 | [diff] [blame] | 130 | - '%Cred': switch color to red |
| 131 | - '%Cgreen': switch color to green |
| 132 | - '%Cblue': switch color to blue |
| 133 | - '%Creset': reset color |
Jeff King | c002922 | 2009-01-17 10:38:46 -0500 | [diff] [blame] | 134 | - '%C(...)': color specification, as described in color.branch.* config option |
Junio C Hamano | 199c45b | 2007-04-09 02:34:05 -0700 | [diff] [blame] | 135 | - '%m': left, right or boundary mark |
Johannes Schindelin | e52a5de | 2007-02-23 01:35:03 +0100 | [diff] [blame] | 136 | - '%n': newline |
Jeff King | 0a0416a | 2010-01-13 12:35:31 -0500 | [diff] [blame] | 137 | - '%%': a raw '%' |
Govind Salinas | 42c8c74 | 2008-03-21 10:05:06 -0500 | [diff] [blame] | 138 | - '%x00': print a byte from a hex code |
René Scharfe | 3288f20 | 2009-11-22 17:15:31 +0100 | [diff] [blame] | 139 | - '%w([<w>[,<i1>[,<i2>]]])': switch line wrapping, like the -w option of |
René Scharfe | 8a3c63e | 2009-11-23 23:40:03 +0100 | [diff] [blame] | 140 | linkgit:git-shortlog[1]. |
Jeff King | fa5b4f3 | 2008-06-12 02:14:28 -0400 | [diff] [blame] | 141 | |
Thomas Rast | 8f8f547 | 2009-10-19 17:48:10 +0200 | [diff] [blame] | 142 | NOTE: Some placeholders may depend on other options given to the |
| 143 | revision traversal engine. For example, the `%g*` reflog options will |
| 144 | insert an empty string unless we are traversing reflog entries (e.g., by |
| 145 | `git log -g`). The `%d` placeholder will use the "short" decoration |
| 146 | format if `--decorate` was not already provided on the command line. |
| 147 | |
Junio C Hamano | 9fa708d | 2009-10-04 23:43:32 -0700 | [diff] [blame] | 148 | If you add a `{plus}` (plus sign) after '%' of a placeholder, a line-feed |
| 149 | is inserted immediately before the expansion if and only if the |
| 150 | placeholder expands to a non-empty string. |
| 151 | |
| 152 | If you add a `-` (minus sign) after '%' of a placeholder, line-feeds that |
| 153 | immediately precede the expansion are deleted if and only if the |
| 154 | placeholder expands to an empty string. |
| 155 | |
Jeff King | fa5b4f3 | 2008-06-12 02:14:28 -0400 | [diff] [blame] | 156 | * 'tformat:' |
| 157 | + |
| 158 | The 'tformat:' format works exactly like 'format:', except that it |
| 159 | provides "terminator" semantics instead of "separator" semantics. In |
| 160 | other words, each commit has the message terminator character (usually a |
| 161 | newline) appended, rather than a separator placed between entries. |
| 162 | This means that the final entry of a single-line format will be properly |
| 163 | terminated with a new line, just as the "oneline" format does. |
| 164 | For example: |
| 165 | + |
| 166 | --------------------- |
| 167 | $ git log -2 --pretty=format:%h 4da45bef \ |
| 168 | | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/' |
| 169 | 4da45be |
| 170 | 7134973 -- NO NEWLINE |
| 171 | |
| 172 | $ git log -2 --pretty=tformat:%h 4da45bef \ |
| 173 | | perl -pe '$_ .= " -- NO NEWLINE\n" unless /\n/' |
| 174 | 4da45be |
| 175 | 7134973 |
| 176 | --------------------- |
Nanako Shiraishi | 3640754 | 2009-02-24 18:59:15 +0900 | [diff] [blame] | 177 | + |
| 178 | In addition, any unrecognized string that has a `%` in it is interpreted |
| 179 | as if it has `tformat:` in front of it. For example, these two are |
| 180 | equivalent: |
| 181 | + |
| 182 | --------------------- |
| 183 | $ git log -2 --pretty=tformat:%h 4da45bef |
| 184 | $ git log -2 --pretty=%h 4da45bef |
| 185 | --------------------- |