Merge branch 'mc/maint-zoneparse' into maint

[git.git] / Documentation / pretty-options.txt

diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt
index 5f21efe40745a98eafff7df67a916b1f1193fae4..d78e121c76ef12b2d72fbdf1558fa967dfdba85b 100644 (file)
--- a/Documentation/pretty-options.txt
+++ b/Documentation/pretty-options.txt
@@ -1,9 +1,11 @@
 --pretty[='<format>']::
+--format[='<format>']::
 
        Pretty-print the contents of the commit logs in a given format,
        where '<format>' can be one of 'oneline', 'short', 'medium',
-       'full', 'fuller', 'email', 'raw' and 'format:<string>'.
-       When omitted, the format defaults to 'medium'.
+       'full', 'fuller', 'email', 'raw' and 'format:<string>'.  See
+       the "PRETTY FORMATS" section for some additional details for each
+       format.  When omitted, the format defaults to 'medium'.
 +
 Note: you can specify the default pretty format in the repository
 configuration (see linkgit:git-config[1]).
@@ -17,9 +19,30 @@ configuration (see linkgit:git-config[1]).
 This should make "--pretty=oneline" a whole lot more readable for
 people using 80-column terminals.
 
+--oneline::
+       This is a shorthand for "--pretty=oneline --abbrev-commit"
+       used together.
+
 --encoding[=<encoding>]::
        The commit objects record the encoding used for the log message
        in their encoding header; this option can be used to tell the
        command to re-code the commit log message in the encoding
        preferred by the user.  For non plumbing commands this
        defaults to UTF-8.
+
+--no-notes::
+--show-notes[=<ref>]::
+       Show the notes (see linkgit:git-notes[1]) that annotate the
+       commit, when showing the commit log message.  This is the default
+       for `git log`, `git show` and `git whatchanged` commands when
+       there is no `--pretty`, `--format` nor `--oneline` option is
+       given on the command line.
++
+With an optional argument, add this ref to the list of notes.  The ref
+is taken to be in `refs/notes/` if it is not qualified.
+
+--[no-]standard-notes::
+       Enable or disable populating the notes ref list from the
+       'core.notesRef' and 'notes.displayRef' variables (or
+       corresponding environment overrides).  Enabled by default.
+       See linkgit:git-config[1].