Re: git notes: notes

From: Jeff King <peff@peff.net>
Date: Jan 20, 2010, 22:25 UTC
Message-ID: <20100120222548.GD15936@coredump.intra.peff.net>
In-Reply-To: <7v3a201lpz.fsf@alter.siamese.dyndns.org>

On Wed, Jan 20, 2010 at 01:59:36PM -0800, Junio C Hamano wrote:

Show 9 quoted lines

> Subject: 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;
> other users can ask for it by setting show_notes field to true.

What I didn't get out of reading this but did from reading the code (I think) is what you meant by "by default" here. That is, doing:

  git log

will show notes, but neither

  git log --pretty=raw

nor even

  git log --pretty=medium

will do so, even though the latter otherwise produces identical output to the default.

That seems like a reasonable rule to me, but I just wanted to make sure that was both what was happening and what was intended.

Show 9 quoted lines

> Signed-off-by: Junio C Hamano <gitster@pobox.com>
> ---
>  builtin-log.c |    2 ++
>  commit.h      |    1 +
>  log-tree.c    |    1 +
>  pretty.c      |    2 +-
>  revision.c    |    4 ++++
>  revision.h    |    1 +
>  6 files changed, 10 insertions(+), 1 deletions(-)

No tests or docs, of course. :) You can squash the --pretty=raw test from my patch, but you will need to exercise --show-notes and --no-show-notes, too, as well as checking other formats and things like format-patch. So probably writing your own tests will make it easier to more thoroughly check each case.

-Peff