[PATCH 01/14] cache.h: add comments for git_path() and git_path_submodule()
From: <hidden>
Date: 2016-06-15 22:52:14
Subsystem:
the rest · Maintainer:
Linus Torvalds
From: Michael Haggerty <redacted> Signed-off-by: Michael Haggerty <redacted> --- cache.h | 15 +++++++++++++++ 1 files changed, 15 insertions(+), 0 deletions(-)
diff --git a/cache.h b/cache.h
index e39e160..b94855e 100644
--- a/cache.h
+++ b/cache.h@@ -660,7 +660,22 @@ 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. + */ extern char *git_path(const char *fmt, ...) __attribute__((format (printf, 1, 2))); + +/* + * Return the path of a file within 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 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)));
--
1.7.7.rc2