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', 'reference', '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 a prefix that names the object uniquely.
  20         "--abbrev=<n>" (which also modifies diff output, if it is displayed)
  21         option can be used to specify the minimum length of the prefix.
  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`, either explicit or implied by other options such
  29         as "--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         Commit objects record the character 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. Likewise, if iconv(3) fails
  44         to convert the commit, we will quietly output the original
  45         object verbatim.
  46
  47 --expand-tabs=<n>::
  48 --expand-tabs::
  49 --no-expand-tabs::
  50         Perform a tab expansion (replace each tab with enough spaces
  51         to fill to the next display column that is multiple of '<n>')
  52         in the log message before showing it in the output.
  53         `--expand-tabs` is a short-hand for `--expand-tabs=8`, and
  54         `--no-expand-tabs` is a short-hand for `--expand-tabs=0`,
  55         which disables tab expansion.
  56 +
  57 By default, tabs are expanded in pretty formats that indent the log
  58 message by 4 spaces (i.e.  'medium', which is the default, 'full',
  59 and 'fuller').
  60
  61 ifndef::git-rev-list[]
  62 --notes[=<ref>]::
  63         Show the notes (see linkgit:git-notes[1]) that annotate the
  64         commit, when showing the commit log message.  This is the default
  65         for `git log`, `git show` and `git whatchanged` commands when
  66         there is no `--pretty`, `--format`, or `--oneline` option given
  67         on the command line.
  68 +
  69 By default, the notes shown are from the notes refs listed in the
  70 `core.notesRef` and `notes.displayRef` variables (or corresponding
  71 environment overrides). See linkgit:git-config[1] for more details.
  72 +
  73 With an optional '<ref>' argument, use the ref to find the notes
  74 to display.  The ref can specify the full refname when it begins
  75 with `refs/notes/`; when it begins with `notes/`, `refs/` and otherwise
  76 `refs/notes/` is prefixed to form a full name of the ref.
  77 +
  78 Multiple --notes options can be combined to control which notes are
  79 being displayed. Examples: "--notes=foo" will show only notes from
  80 "refs/notes/foo"; "--notes=foo --notes" will show both notes from
  81 "refs/notes/foo" and from the default notes ref(s).
  82
  83 --no-notes::
  84         Do not show notes. This negates the above `--notes` option, by
  85         resetting the list of notes refs from which notes are shown.
  86         Options are parsed in the order given on the command line, so e.g.
  87         "--notes --notes=foo --no-notes --notes=bar" will only show notes
  88         from "refs/notes/bar".
  89
  90 --show-notes-by-default::
  91         Show the default notes unless options for displaying specific
  92         notes are given.
  93
  94 --show-notes[=<ref>]::
  95 --[no-]standard-notes::
  96         These options are deprecated. Use the above --notes/--no-notes
  97         options instead.
  98 endif::git-rev-list[]
  99
 100 --show-signature::
 101         Check the validity of a signed commit object by passing the signature
 102         to `gpg --verify` and show the output.