[PATCH v3 01/14] cache.h: add comments for git_path() and git_path_submodule()

[mhagger@alum.mit.edu]

From: Michael Haggerty <mhagger@alum.mit.edu>


Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
---
 cache.h |   18 ++++++++++++++++++
 1 files changed, 18 insertions(+), 0 deletions(-)

diff --git a/cache.h b/cache.h
index 2e6ad36..5e807b9 100644
--- a/cache.h
+++ b/cache.h
@@ -662,7 +662,25 @@ extern char *git_pathdup(const char *fmt, ...)
 
 /* Return a statically allocated filename matching the sha1 signature */
 extern char *mkpath(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
+
+/*
+ * 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.  The return value is a pointer into a temporary
+ * buffer that will be overwritten without notice.
+ */
 extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2)));
+
+/*
+ * Return the path of a file within the git_dir of the submodule
+ * located at path.  The other arguments should be printf-like
+ * arguments that produce the filename relative to "<path>/.git".  If
+ * "<path>/.git" is a gitlink file, follow it to find the actual
+ * submodule git_dir.  Return the resulting path, or "/bad-path/" if
+ * there is an error.  The return value is a pointer into a temporary
+ * buffer that will be overwritten without notice.
+ */
 extern char *git_path_submodule(const char *path, const char *fmt, ...)
 	__attribute__((format (printf, 2, 3)));
 
-- 
1.7.7