path: root/Documentation/pretty-options.txt
diff options
authorJunio C Hamano <>2010-01-20 21:59:36 (GMT)
committerJunio C Hamano <>2010-01-21 03:57:02 (GMT)
commit66b2ed09c2f0f212c5cd5c095c1f1052ecbb9491 (patch)
tree3dae0edece540e07d06146bb6a5dbf5f6873aec6 /Documentation/pretty-options.txt
parent9504f3d3d2e62cb6fba9e7c61c6fe69dec9053a4 (diff)
Fix "log" family not to be too agressive about showing notes
Giving "Notes" information in the default output format of "log" and "show" is a sensible progress (the user has asked for it by having the notes), but for some commands (e.g. "format-patch") spewing notes into the formatted commit log message without being asked is too aggressive. Enable notes output only for "log", "show", "whatchanged" by default and only when the user didn't ask any specific --pretty/--format from the command line; users can explicitly override this default with --show-notes and --no-notes option. Parts of tests are taken from Jeff King's fix. Signed-off-by: Jeff King <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/pretty-options.txt')
1 files changed, 8 insertions, 0 deletions
diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt
index bff9499..1401200 100644
--- a/Documentation/pretty-options.txt
+++ b/Documentation/pretty-options.txt
@@ -28,3 +28,11 @@ people using 80-column terminals.
command to re-code the commit log message in the encoding
preferred by the user. For non plumbing commands this
defaults to UTF-8.
+ 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` nor `--format` option is given on the
+ command line.