Merge branch 'jc/maint-doc-em-dash'
[git/jnareb-git/bp-gitweb.git] / Documentation / pretty-options.txt
blob9b6f3899ec28fb431c1f3969bf5bfb717c12f346
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 --oneline::
23         This is a shorthand for "--pretty=oneline --abbrev-commit"
24         used together.
26 --encoding[=<encoding>]::
27         The commit objects record the encoding used for the log message
28         in their encoding header; this option can be used to tell the
29         command to re-code the commit log message in the encoding
30         preferred by the user.  For non plumbing commands this
31         defaults to UTF-8.
33 --no-notes::
34 --show-notes[=<ref>]::
35         Show the notes (see linkgit:git-notes[1]) that annotate the
36         commit, when showing the commit log message.  This is the default
37         for `git log`, `git show` and `git whatchanged` commands when
38         there is no `--pretty`, `--format` nor `--oneline` option is
39         given on the command line.
41 With an optional argument, add this ref to the list of notes.  The ref
42 is taken to be in `refs/notes/` if it is not qualified.
44 --[no-]standard-notes::
45         Enable or disable populating the notes ref list from the
46         'core.notesRef' and 'notes.displayRef' variables (or
47         corresponding environment overrides).  Enabled by default.
48         See linkgit:git-config[1].