From: Michael Haggerty <mhagger@alum.mit.edu>
Date: Tue, 16 Apr 2013 09:11:36 GMT
Subject: Re: [PATCH 03/33] refs: document do_for_each_ref() and do_one_ref()
Message-ID: <516D15C8.2050500@alum.mit.edu>
In-Reply-To: <7vobdfwv7m.fsf@alter.siamese.dyndns.org>

On 04/15/2013 07:38 PM, Junio C Hamano wrote:
>> +/*
>> + * Call fn for each reference in the specified submodule for which the
>> + * refname begins with base.  If trim is non-zero, then trim that many
>> + * characters off the beginning of each refname before passing the
>> + * refname to fn.  flags can be DO_FOR_EACH_INCLUDE_BROKEN to include
>> + * broken references in the iteration.
>> + */
> 
> Early termination due to "fn()" returning non-zero needs to be
> documented here, no?
> 
>>  static int do_for_each_ref(const char *submodule, const char *base, each_ref_fn fn,

Correct, thanks.  Will be fixed in re-roll.

Michael

-- 
Michael Haggerty
mhagger@alum.mit.edu
http://softwareswirl.blogspot.com/