Re: [PATCHv4 05/21] notes.h/c: Clarify the handling of notes objects that are == null_sha1

From: Johan Herland <johan@herland.net>
Date: Oct 21, 2010, 13:13 UTC
Message-ID: <201010211513.06176.johan@herland.net>
In-Reply-To: <20101021051232.GA2413@burratino>

On Thursday 21 October 2010, Jonathan Nieder wrote:

Show 10 quoted lines

> Johan Herland wrote:
> > Clearly specify how combine_notes functions are expected to handle
> > null_sha1 in input. Also specify (and implement) that returning
> > null_sha1 from a combine_notes function will cause the note in
> > question to be removed.
>
> Ack again on patches 1-4.  As for this one, I still think the log
> message does not make the goal obvious.
>
> [...]

Ok, I liked your alternative message much better. The next iteration will have this commit message:

  notes.h/c: Allow combine_notes functions to remove notes

  Allow combine_notes functions to request that a note be removed,
  by setting the resulting note SHA1 to null_sha1 (0000000...).

  For consistency, also teach note_tree_insert() to skip insertion
  of an empty note when there is no note to combine it with.

  In general, an empty note is treated identically to no note at
  all, but when adding an empty note where there already exists a
  non-empty note, we allow the combine_notes function to potentially
  record a new/changed note. Document this behaviour, and clearly
  specify how combine_notes functions are expected to handle null_sha1
  in input.

Thanks again, for your superhuman patience in reviewing.

...Johan

-- 
Johan Herland, <johan@herland.net>
www.herland.net