Update draft release notes to 1.7.1
[git/kirr.git] / Documentation / pretty-options.txt
blobaf6d2b995a050007ae088dec8e2c3474e9f06ad5
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>'.
7         When omitted, the format defaults to 'medium'.
9 Note: you can specify the default pretty format in the repository
10 configuration (see linkgit:git-config[1]).
12 --abbrev-commit::
13         Instead of showing the full 40-byte hexadecimal commit object
14         name, show only a partial prefix.  Non default number of
15         digits can be specified with "--abbrev=<n>" (which also modifies
16         diff output, if it is displayed).
18 This should make "--pretty=oneline" a whole lot more readable for
19 people using 80-column terminals.
21 --oneline::
22         This is a shorthand for "--pretty=oneline --abbrev-commit"
23         used together.
25 --encoding[=<encoding>]::
26         The commit objects record the encoding used for the log message
27         in their encoding header; this option can be used to tell the
28         command to re-code the commit log message in the encoding
29         preferred by the user.  For non plumbing commands this
30         defaults to UTF-8.
32 --no-notes::
33 --show-notes[=<ref>]::
34         Show the notes (see linkgit:git-notes[1]) that annotate the
35         commit, when showing the commit log message.  This is the default
36         for `git log`, `git show` and `git whatchanged` commands when
37         there is no `--pretty`, `--format` nor `--oneline` option is
38         given on the command line.
40 With an optional argument, add this ref to the list of notes.  The ref
41 is taken to be in `refs/notes/` if it is not qualified.
43 --[no-]standard-notes::
44         Enable or disable populating the notes ref list from the
45         'core.notesRef' and 'notes.displayRef' variables (or
46         corresponding environment overrides).  Enabled by default.
47         See linkgit:git-config[1].