git-prompt: do not look for refs/stash in $GIT_DIR
[git.git] / Documentation / pretty-options.txt
blob8569e29d08784cb5eb053af919e4b7514b1c296b
1 --pretty[=<format>]::
2 --format=<format>::
4         Pretty-print the contents of the commit logs in a given format,
5         where '<format>' can be one of 'oneline', 'short', 'medium',
6         'full', 'fuller', 'email', 'raw' and 'format:<string>'.  See
7         the "PRETTY FORMATS" section for some additional details for each
8         format.  When omitted, the format defaults to 'medium'.
10 Note: you can specify the default pretty format in the repository
11 configuration (see linkgit:git-config[1]).
13 --abbrev-commit::
14         Instead of showing the full 40-byte hexadecimal commit object
15         name, show only a partial prefix.  Non default number of
16         digits can be specified with "--abbrev=<n>" (which also modifies
17         diff output, if it is displayed).
19 This should make "--pretty=oneline" a whole lot more readable for
20 people using 80-column terminals.
22 --no-abbrev-commit::
23         Show the full 40-byte hexadecimal commit object name. This negates
24         `--abbrev-commit` and those options which imply it such as
25         "--oneline". It also overrides the 'log.abbrevCommit' variable.
27 --oneline::
28         This is a shorthand for "--pretty=oneline --abbrev-commit"
29         used together.
31 --encoding=<encoding>::
32         The commit objects record the encoding used for the log message
33         in their encoding header; this option can be used to tell the
34         command to re-code the commit log message in the encoding
35         preferred by the user.  For non plumbing commands this
36         defaults to UTF-8.
38 --notes[=<ref>]::
39         Show the notes (see linkgit:git-notes[1]) that annotate the
40         commit, when showing the commit log message.  This is the default
41         for `git log`, `git show` and `git whatchanged` commands when
42         there is no `--pretty`, `--format`, or `--oneline` option given
43         on the command line.
45 By default, the notes shown are from the notes refs listed in the
46 'core.notesRef' and 'notes.displayRef' variables (or corresponding
47 environment overrides). See linkgit:git-config[1] for more details.
49 With an optional '<ref>' argument, show this notes ref instead of the
50 default notes ref(s). The ref is taken to be in `refs/notes/` if it
51 is not qualified.
53 Multiple --notes options can be combined to control which notes are
54 being displayed. Examples: "--notes=foo" will show only notes from
55 "refs/notes/foo"; "--notes=foo --notes" will show both notes from
56 "refs/notes/foo" and from the default notes ref(s).
58 --no-notes::
59         Do not show notes. This negates the above `--notes` option, by
60         resetting the list of notes refs from which notes are shown.
61         Options are parsed in the order given on the command line, so e.g.
62         "--notes --notes=foo --no-notes --notes=bar" will only show notes
63         from "refs/notes/bar".
65 --show-notes[=<ref>]::
66 --[no-]standard-notes::
67         These options are deprecated. Use the above --notes/--no-notes
68         options instead.
70 --show-signature::
71         Check the validity of a signed commit object by passing the signature
72         to `gpg --verify` and show the output.