From: Junio C Hamano <gitster@pobox•com>
To: mhagger@alum•mit.edu
Cc: Junio C Hamano <gitster@pobox•com>,
git@vger•kernel.org, Jeff King <peff@peff•net>,
Drew Northup <drew.northup@maine•edu>,
Jakub Narebski <jnareb@gmail•com>,
Heiko Voigt <hvoigt@hvoigt•net>,
Johan Herland <johan@herland•net>,
Julian Phillips <julian@quantumfyre•co.uk>
Subject: Re: [PATCH 01/14] cache.h: add comments for git_path() and git_path_submodule()
Date: Thu, 13 Oct 2011 11:37:00 -0700 [thread overview]
Message-ID: <7vvcrs4u2b.fsf@alter.siamese.dyndns.org> (raw)
In-Reply-To: <1318492715-5931-2-git-send-email-mhagger@alum.mit.edu> (mhagger@alum.mit.edu's message of "Thu, 13 Oct 2011 09:58:22 +0200")
mhagger@alum•mit.edu writes:
> +
> +/*
> + * Return the path of a file within get_git_dir(). The arguments
> + * should be printf-like arguments that produce the filename relative
> + * to get_git_dir(). Return the resulting path, or "/bad-path/" if
> + * there is an error.
> + */
> extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
Ok.
> +/*
> + * Return the path of a file within the submodule located at path.
This is confusing. Does this "file within the submodule" refer to files
like "Makefile" tracked in a submodule at "dir"? Your description for
git_path() above makes it clear that the function is about files like
"index" and "HEAD" that are part of the control information for the
current project, but the above gives an impression that you are talking
about files in the working tree of the submodule.
> + * The other arguments should be printf-like arguments that produce
> + * the filename relative to "<path>/.git". If "<path>/.git" is a
And the reader is puzzled by the sudden mention of <path>/.git here.
> + * gitlink file, follow it to find the actual submodule git path.
> + * Return the resulting path, or "/bad-path/" if there is an error.
> + */
> extern char *git_path_submodule(const char *path, const char *fmt, ...)
> __attribute__((format (printf, 2, 3)));
next prev parent reply other threads:[~2011-10-13 18:37 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-10-13 7:58 [PATCH 00/14] Tidying up references code mhagger
2011-10-13 7:58 ` [PATCH 01/14] cache.h: add comments for git_path() and git_path_submodule() mhagger
2011-10-13 18:37 ` Junio C Hamano [this message]
2011-10-13 7:58 ` [PATCH 02/14] struct ref_list: document name member mhagger
2011-10-13 18:37 ` Junio C Hamano
2011-10-13 7:58 ` [PATCH 03/14] refs.c: rename some local "refname" variables mhagger
2011-10-13 7:58 ` [PATCH 04/14] refs: rename some parameters result -> sha1 mhagger
2011-10-13 18:42 ` Junio C Hamano
2011-10-13 7:58 ` [PATCH 05/14] clear_ref_list(): rename from free_ref_list() mhagger
2011-10-13 18:43 ` Junio C Hamano
2011-10-13 7:58 ` [PATCH 06/14] resolve_gitlink_ref(): improve docstring mhagger
2011-10-13 18:48 ` Junio C Hamano
2011-10-13 7:58 ` [PATCH 07/14] is_refname_available(): remove the "quiet" argument mhagger
2011-10-13 12:41 ` Drew Northup
2011-10-13 18:49 ` Junio C Hamano
2011-10-14 5:35 ` Michael Haggerty
2011-10-13 7:58 ` [PATCH 08/14] parse_ref_line(): add docstring mhagger
2011-10-13 7:58 ` [PATCH 09/14] add_ref(): " mhagger
2011-10-13 7:58 ` [PATCH 10/14] is_dup_ref(): extract function from sort_ref_list() mhagger
2011-10-13 20:43 ` Junio C Hamano
2011-10-13 7:58 ` [PATCH 11/14] refs: change signatures of get_packed_refs() and get_loose_refs() mhagger
2011-10-13 7:58 ` [PATCH 12/14] get_ref_dir(): change signature mhagger
2011-10-13 7:58 ` [PATCH 13/14] Pass a (cached_refs *) to the resolve_gitlink_*() functions mhagger
2011-10-13 7:58 ` [PATCH 14/14] resolve_gitlink_ref_recursive(): change to work with struct cached_refs mhagger
2011-10-13 8:06 ` [PATCH] t1402-check-ref-format: skip tests of refs beginning with slash on Windows Johannes Sixt
2011-10-13 23:00 ` Junio C Hamano
2011-10-13 23:07 ` Junio C Hamano
2011-10-14 6:40 ` Johannes Sixt
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=7vvcrs4u2b.fsf@alter.siamese.dyndns.org \
--to=gitster@pobox$(echo .)com \
--cc=drew.northup@maine$(echo .)edu \
--cc=git@vger$(echo .)kernel.org \
--cc=hvoigt@hvoigt$(echo .)net \
--cc=jnareb@gmail$(echo .)com \
--cc=johan@herland$(echo .)net \
--cc=julian@quantumfyre$(echo .)co.uk \
--cc=mhagger@alum$(echo .)mit.edu \
--cc=peff@peff$(echo .)net \
/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