Merge branch 'sg/git-test-boolean'
[gitweb.git] / Documentation / pretty-formats.txt
index dcb686e88f134a671d5e132f9b047000e6cf7ebe..079598307a3897d913de030a4737ce2e43c1810d 100644 (file)
@@ -119,7 +119,7 @@ The placeholders are:
            the `auto` settings of the former if we are going to a
            terminal). `%C(auto,...)` is accepted as a historical
            synonym for the default (e.g., `%C(auto,red)`). Specifying
-           `%C(always,...) will show the colors even when color is
+           `%C(always,...)` will show the colors even when color is
            not otherwise enabled (though consider just using
            `--color=always` to enable color for the whole output,
            including this format and anything else git might color).
@@ -183,6 +183,8 @@ The placeholders are:
 '%cI':: committer date, strict ISO 8601 format
 '%d':: ref names, like the --decorate option of linkgit:git-log[1]
 '%D':: ref names without the " (", ")" wrapping.
+'%S':: ref name given on the command line by which the commit was reached
+       (like `git log --source`), only works with `git log`
 '%e':: encoding
 '%s':: subject
 '%f':: sanitized subject line, suitable for a filename
@@ -225,16 +227,35 @@ endif::git-rev-list[]
                          linkgit:git-interpret-trailers[1]. The
                          `trailers` string may be followed by a colon
                          and zero or more comma-separated options:
+** 'key=<K>': only show trailers with specified key. Matching is done
+   case-insensitively and trailing colon is optional. If option is
+   given multiple times trailer lines matching any of the keys are
+   shown. This option automatically enables the `only` option so that
+   non-trailer lines in the trailer block are hidden. If that is not
+   desired it can be disabled with `only=false`.  E.g.,
+   `%(trailers:key=Reviewed-by)` shows trailer lines with key
+   `Reviewed-by`.
 ** 'only[=val]': select whether non-trailer lines from the trailer
    block should be included. The `only` keyword may optionally be
    followed by an equal sign and one of `true`, `on`, `yes` to omit or
    `false`, `off`, `no` to show the non-trailer lines. If option is
    given without value it is enabled. If given multiple times the last
    value is used.
+** 'separator=<SEP>': specify a separator inserted between trailer
+   lines. When this option is not given each trailer line is
+   terminated with a line feed character. The string SEP may contain
+   the literal formatting codes described above. To use comma as
+   separator one must use `%x2C` as it would otherwise be parsed as
+   next option. If separator option is given multiple times only the
+   last one is used. E.g., `%(trailers:key=Ticket,separator=%x2C )`
+   shows all trailer lines whose key is "Ticket" separated by a comma
+   and a space.
 ** 'unfold[=val]': make it behave as if interpret-trailer's `--unfold`
    option was given. In same way as to for `only` it can be followed
    by an equal sign and explicit value. E.g.,
    `%(trailers:only,unfold=true)` unfolds and shows all trailer lines.
+** 'valueonly[=val]': skip over the key part of the trailer line and only
+   show the value part. Also this optionally allows explicit value.
 
 NOTE: Some placeholders may depend on other options given to the
 revision traversal engine. For example, the `%g*` reflog options will