From: Michael Haggerty Date: Wed, 27 Apr 2016 16:57:18 GMT Subject: [PATCH 01/29] safe_create_leading_directories(): improve docstring Message-ID: <4e04c27d057a757f82d039d4875a95229e68ac4e.1461768689.git.mhagger@alum.mit.edu> In-Reply-To: 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 --- cache.h | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/cache.h b/cache.h index 2711048..4134f64 100644 --- a/cache.h +++ b/cache.h @@ -993,6 +993,11 @@ int adjust_shared_perm(const char *path); * directory while we were working. To be robust against this kind of * race, callers might want to try invoking the function again when it * 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 { SCLD_OK = 0, -- 2.8.1