blob: d5c977262a818683ebd47d77d37a26c66737119f [file] [log] [blame]
Junio C Hamanod2179ef2010-10-22 04:12:171--pretty[=<format>]::
2--format=<format>::
Junio C Hamano0430e3a2007-05-15 03:13:173
Junio C Hamanoa3770f92007-07-25 08:53:334Pretty-print the contents of the commit logs in a given format,
Junio C Hamano0430e3a2007-05-15 03:13:175where '<format>' can be one of 'oneline', 'short', 'medium',
Junio C Hamanoe32ec8b2010-06-02 23:32:316'full', 'fuller', 'email', 'raw' and 'format:<string>'. See
7the "PRETTY FORMATS" section for some additional details for each
8format. When omitted, the format defaults to 'medium'.
Junio C Hamano86bcccc2008-03-08 09:33:559+
10Note: you can specify the default pretty format in the repository
11configuration (see linkgit:git-config[1]).
Junio C Hamano0430e3a2007-05-15 03:13:1712
Junio C Hamanoee695f22007-06-21 00:35:3613--abbrev-commit::
14Instead of showing the full 40-byte hexadecimal commit object
Junio C Hamano6efe3022009-01-13 16:47:5615name, show only a partial prefix. Non default number of
Junio C Hamanoee695f22007-06-21 00:35:3616digits can be specified with "--abbrev=<n>" (which also modifies
17diff output, if it is displayed).
18+
19This should make "--pretty=oneline" a whole lot more readable for
20people using 80-column terminals.
21
Junio C Hamano0a235222009-03-06 08:21:0922--oneline::
23This is a shorthand for "--pretty=oneline --abbrev-commit"
24used together.
25
Junio C Hamano0430e3a2007-05-15 03:13:1726--encoding[=<encoding>]::
27The commit objects record the encoding used for the log message
28in their encoding header; this option can be used to tell the
29command to re-code the commit log message in the encoding
30preferred by the user. For non plumbing commands this
31defaults to UTF-8.
Junio C Hamano57827fb2010-01-23 03:02:5032
Junio C Hamano60033462011-05-03 00:48:4333--notes[=<ref>]::
Junio C Hamano57827fb2010-01-23 03:02:5034Show the notes (see linkgit:git-notes[1]) that annotate the
35commit, when showing the commit log message. This is the default
36for `git log`, `git show` and `git whatchanged` commands when
Junio C Hamano60033462011-05-03 00:48:4337there is no `--pretty`, `--format` nor `--oneline` option given
38on the command line.
Junio C Hamano31667362010-03-25 00:38:5339+
Junio C Hamano60033462011-05-03 00:48:4340By default, the notes shown are from the notes refs listed in the
41'core.notesRef' and 'notes.displayRef' variables (or corresponding
42environment overrides). See linkgit:git-config[1] for more details.
43+
44With an optional '<ref>' argument, show this notes ref instead of the
45default notes ref(s). The ref is taken to be in `refs/notes/` if it
46is not qualified.
47+
48Multiple --notes options can be combined to control which notes are
49being displayed. Examples: "--notes=foo" will show only notes from
50"refs/notes/foo"; "--notes=foo --notes" will show both notes from
51"refs/notes/foo" and from the default notes ref(s).
Junio C Hamano31667362010-03-25 00:38:5352
Junio C Hamano60033462011-05-03 00:48:4353--no-notes::
54Do not show notes. This negates the above `--notes` option, by
55resetting the list of notes refs from which notes are shown.
56Options are parsed in the order given on the command line, so e.g.
57"--notes --notes=foo --no-notes --notes=bar" will only show notes
58from "refs/notes/bar".
59
60--show-notes[=<ref>]::
Junio C Hamano31667362010-03-25 00:38:5361--[no-]standard-notes::
Junio C Hamano60033462011-05-03 00:48:4362These options are deprecated. Use the above --notes/--no-notes
63options instead.