Re: [PATCH 5/6] Document a bunch of functions defined in sha1_file.c

2014-02-25 Thread Michael Haggerty
On 02/24/2014 09:08 PM, Jonathan Nieder wrote: > Michael Haggerty wrote: >> [...] I've been documenting public functions in the >> header files above the declaration, and private ones where they are >> defined. [...] >> >> Let me know if you think I've made it less helpful. > > In the present st

Re: [PATCH 5/6] Document a bunch of functions defined in sha1_file.c

2014-02-24 Thread Jonathan Nieder
Hi, Michael Haggerty wrote: > No, this hasn't changed. I've been documenting public functions in the > header files above the declaration, and private ones where they are > defined. So I moved the documentation for this function to cache.h: > > +/* > + * Return the name of the file in the local

Re: [PATCH 5/6] Document a bunch of functions defined in sha1_file.c

2014-02-24 Thread Michael Haggerty
On 02/24/2014 07:18 PM, Jakub Narębski wrote: > Michael Haggerty wrote: > >> -/* >> - * NOTE! This returns a statically allocated buffer, so you have to be >> - * careful about using it. Do an "xstrdup()" if you need to save the >> - * filename. >> - * >> - * Also note that this returns the locati

Re: [PATCH 5/6] Document a bunch of functions defined in sha1_file.c

2014-02-24 Thread Jakub Narębski
Michael Haggerty wrote: -/* - * NOTE! This returns a statically allocated buffer, so you have to be - * careful about using it. Do an "xstrdup()" if you need to save the - * filename. - * - * Also note that this returns the location for creating. Reading - * SHA1 file can happen from any altern

Re: [PATCH 5/6] Document a bunch of functions defined in sha1_file.c

2014-02-21 Thread Nicolas Pitre
On Fri, 21 Feb 2014, Michael Haggerty wrote: > Signed-off-by: Michael Haggerty Acked-by: Nicolas Pitre > --- > cache.h | 66 > ++--- > sha1_file.c | 26 +--- > 2 files changed, 78 insertions(+), 14 deletions(-)

[PATCH 5/6] Document a bunch of functions defined in sha1_file.c

2014-02-21 Thread Michael Haggerty
Signed-off-by: Michael Haggerty --- cache.h | 66 ++--- sha1_file.c | 26 +--- 2 files changed, 78 insertions(+), 14 deletions(-) diff --git a/cache.h b/cache.h index 1663478..e62fdec 100644 --- a/cache.h +++ b/cache