From: Stephen Boyd <bebarino@gmail•com>
To: Junio C Hamano <gitster@pobox•com>
Cc: git@vger•kernel.org
Subject: Re: [PATCH] technical-docs: document tree-walking API
Date: Mon, 03 Aug 2009 23:00:59 -0700 [thread overview]
Message-ID: <4A77CE9B.2060102@gmail.com> (raw)
In-Reply-To: <7v4oso87fy.fsf@alter.siamese.dyndns.org>
Junio C Hamano wrote:
> 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).
I'm ok with dropping the Authors section then.
>
> 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.
This sounds reasonable for the traversing section. I'm a bit confused
about how it would work for the walking section though. I don't get the
notion of path components there because the API is focused around one
level of a tree. Maybe it should just be called the entry's name in that
case?
prev parent reply other threads:[~2009-08-04 6:01 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2009-08-04 4:13 [PATCH] technical-docs: document tree-walking API Stephen Boyd
2009-08-04 5:38 ` Junio C Hamano
2009-08-04 6:00 ` Stephen Boyd [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=4A77CE9B.2060102@gmail.com \
--to=bebarino@gmail$(echo .)com \
--cc=git@vger$(echo .)kernel.org \
--cc=gitster@pobox$(echo .)com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox