> On 08 Sep 2016, at 23:24, Stefan Beller <sbel...@google.com> wrote: > > On Thu, Sep 8, 2016 at 11:21 AM, <larsxschnei...@gmail.com> wrote: > >> >> Add packet_write_gently() which writes arbitrary data and returns `0` >> for success and `-1` for an error. > > I think documenting the return code is better done in either the header file > or in a commend preceding the implementation instead of the commit message? > > Maybe just a generic comment for *_gently is good enough, maybe even no > comment. So the commit is fine, too. I dunno.
I agree that this is too verbose as this function follows the standard Git return value conventions (AFAIK). I'll remove this from all commit messages. >> This function is used by other >> pkt-line functions in a subsequent patch. > > That's what I figured. Do we also need to mention that in the preceding patch > for packet_flush_gently ? I'll add this note to all commit messages that introduce new functions which are used later. Thanks, Lars