git.oblomov.eu Git - git/blob - 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' and 'format:<string>'.  See
   7         the "PRETTY FORMATS" section for some additional details for each
   8         format.  When omitted, the format defaults to 'medium'.
   9 +
  10 Note: you can specify the default pretty format in the repository
  11 configuration (see linkgit:git-config[1]).
  12
  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).
  18 +
  19 This should make "--pretty=oneline" a whole lot more readable for
  20 people using 80-column terminals.
  21
  22 --oneline::
  23         This is a shorthand for "--pretty=oneline --abbrev-commit"
  24         used together.
  25
  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.
  32
  33 --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 given
  38         on the command line.
  39 +
  40 By default, the notes shown are from the notes refs listed in the
  41 'core.notesRef' and 'notes.displayRef' variables (or corresponding
  42 environment overrides). See linkgit:git-config[1] for more details.
  43 +
  44 With an optional '<ref>' argument, show this notes ref instead of the
  45 default notes ref(s). The ref is taken to be in `refs/notes/` if it
  46 is not qualified.
  47 +
  48 Multiple --notes options can be combined to control which notes are
  49 being 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).
  52
  53 --no-notes::
  54         Do not show notes. This negates the above `--notes` option, by
  55         resetting the list of notes refs from which notes are shown.
  56         Options 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
  58         from "refs/notes/bar".
  59
  60 --show-notes[=<ref>]::
  61 --[no-]standard-notes::
  62         These options are deprecated. Use the above --notes/--no-notes
  63         options instead.