undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

safe_create_leading_directories(): improve docstring

Browse Source 
Document the difference between this function and
safe_create_leading_directories_const(), and that the former restores
path before returning.

Signed-off-by: Michael Haggerty <mhagger@alum.mit.edu>
This commit is contained in:
Michael Haggerty 2016-04-24 04:34:12 +02:00
parent e167a5673e
commit e95792e532
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
cache.h
View File

@ -993,6 +993,11 @@ int adjust_shared_perm(const char *path);
* directory while we were working. To be robust against this kind of * directory while we were working. To be robust against this kind of
* race, callers might want to try invoking the function again when it * race, callers might want to try invoking the function again when it
* returns SCLD_VANISHED. * returns SCLD_VANISHED.
*
* safe_create_leading_directories() temporarily changes path while it
* is working but restores it before returning.
* safe_create_leading_directories_const() doesn't modify path, even
* temporarily.
*/ */
enum scld_error { enum scld_error {
SCLD_OK = 0, SCLD_OK = 0,