Re: [PATCH] technical-docs: document tree-walking API

From: Junio C Hamano <gitster@pobox.com>
Date: Aug 4, 2009, 05:38 UTC
Message-ID: <7v4oso87fy.fsf@alter.siamese.dyndns.org>
In-Reply-To: <1249359201-7672-1-git-send-email-bebarino@gmail.com>

Stephen Boyd <bebarino@gmail.com> writes:

Show 5 quoted lines

> Signed-off-by: Stephen Boyd <bebarino@gmail.com>
> ---
>
> This is a minor update incorporating feedback from Junio. Plus, I decided to
> add an authors section.

I think the primary author is Linus for this API, but once you finished the documentation, I do not think "authors" section is particularly needed (git knows who the code came from reasonably well anyway). The names of people in these stub documents were there for people like you; see 530e741 (Start preparing the API documents., 2007-11-24).

It might be a bit misleading to say that the path member of struct name_entry is a "pathname". It is _one_ path component, and by stringing multiple struct traverse_info's (each of which has one struct name_entry) together with their prev pointer, make_traverse_path() can reconstruct the full pathname from the toplevel down to the level you have traversed into. We may want to say "path component" to clarify the distinction.

But these are minor points.  I'll apply the patch as-is.

Thanks.