global/git
1
0
Fork 0
mirror of https://github.com/git/git.git synced 2026-03-16 19:50:09 +01:00
Code Issues Packages Projects Releases Wiki Activity

cache.h: add comments for git_path() and git_path_submodule()

Browse Source 
Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Michael Haggerty
2011-10-17 09:39:10 +02:00
committed by Junio C Hamano
parent c5f29abd80
commit 098977b0d9
1 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
cache.h
View File

@@ -660,7 +660,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)));