Documentation/pretty-options.txt

   1 --pretty[=<format>]::
   2 --format=<format>::
   3
   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', 'format:<string>'
   7         and 'tformat:<string>'.  When '<format>' is none of the above,
   8         and has '%placeholder' in it, it acts as if
   9         '--pretty=tformat:<format>' were given.
  10 +
  11 See the "PRETTY FORMATS" section for some additional details for each
  12 format.  When '=<format>' part is omitted, it defaults to 'medium'.
  13 +
  14 Note: you can specify the default pretty format in the repository
  15 configuration (see linkgit:git-config[1]).
  16
  17 --abbrev-commit::
  18         Instead of showing the full 40-byte hexadecimal commit object
  19         name, show only a partial prefix.  Non default number of
  20         digits can be specified with "--abbrev=<n>" (which also modifies
  21         diff output, if it is displayed).
  22 +
  23 This should make "--pretty=oneline" a whole lot more readable for
  24 people using 80-column terminals.
  25
  26 --no-abbrev-commit::
  27         Show the full 40-byte hexadecimal commit object name. This negates
  28         `--abbrev-commit` and those options which imply it such as
  29         "--oneline". It also overrides the 'log.abbrevCommit' variable.
  30
  31 --oneline::
  32         This is a shorthand for "--pretty=oneline --abbrev-commit"
  33         used together.
  34
  35 --encoding=<encoding>::
  36         The commit objects record the encoding used for the log message
  37         in their encoding header; this option can be used to tell the
  38         command to re-code the commit log message in the encoding
  39         preferred by the user.  For non plumbing commands this
  40         defaults to UTF-8. Note that if an object claims to be encoded
  41         in `X` and we are outputting in `X`, we will output the object
  42         verbatim; this means that invalid sequences in the original
  43         commit may be copied to the output.
  44
  45 --notes[=<ref>]::
  46         Show the notes (see linkgit:git-notes[1]) that annotate the
  47         commit, when showing the commit log message.  This is the default
  48         for `git log`, `git show` and `git whatchanged` commands when
  49         there is no `--pretty`, `--format`, or `--oneline` option given
  50         on the command line.
  51 +
  52 By default, the notes shown are from the notes refs listed in the
  53 'core.notesRef' and 'notes.displayRef' variables (or corresponding
  54 environment overrides). See linkgit:git-config[1] for more details.
  55 +
  56 With an optional '<ref>' argument, show this notes ref instead of the
  57 default notes ref(s). The ref is taken to be in `refs/notes/` if it
  58 is not qualified.
  59 +
  60 Multiple --notes options can be combined to control which notes are
  61 being displayed. Examples: "--notes=foo" will show only notes from
  62 "refs/notes/foo"; "--notes=foo --notes" will show both notes from
  63 "refs/notes/foo" and from the default notes ref(s).
  64
  65 --no-notes::
  66         Do not show notes. This negates the above `--notes` option, by
  67         resetting the list of notes refs from which notes are shown.
  68         Options are parsed in the order given on the command line, so e.g.
  69         "--notes --notes=foo --no-notes --notes=bar" will only show notes
  70         from "refs/notes/bar".
  71
  72 --show-notes[=<ref>]::
  73 --[no-]standard-notes::
  74         These options are deprecated. Use the above --notes/--no-notes
  75         options instead.
  76
  77 --show-signature::
  78         Check the validity of a signed commit object by passing the signature
  79         to `gpg --verify` and show the output.