path: refactor `repo_git_path()` family of functions

As explained in an earlier commit, we're refactoring path-related
functions to provide a consistent interface for computing paths into the
commondir, gitdir and worktree. Refactor the "gitdir" family of
functions accordingly.

Note that the `repo_git_pathv()` function is converted into an internal
implementation detail. It is only used to implement `the_repository`
compatibility shims and will eventually be removed from the public
interface.

Signed-off-by: Patrick Steinhardt <ps@pks.im>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/editor.c b/editor.c
index 6b9ce81d5fc0fdc44dbf75ac4eedf2f218300caa..b79d97b0e721c239772bf70397ac98426c155e52 100644 (file)
--- a/editor.c
+++ b/editor.c
@@ -142,10 +142,8 @@ int strbuf_edit_interactively(struct repository *r,
        struct strbuf sb = STRBUF_INIT;
        int fd, res = 0;
 
-       if (!is_absolute_path(path)) {
-               strbuf_repo_git_path(&sb, r, "%s", path);
-               path = sb.buf;
-       }
+       if (!is_absolute_path(path))
+               path = repo_git_path_append(r, &sb, "%s", path);
 
        fd = open(path, O_WRONLY | O_CREAT | O_TRUNC, 0666);
        if (fd < 0)

diff --git a/hook.c b/hook.c
index 9ddbdee06d57749bf3b1e595a1ef0c7a23da7a16..b3de1048bf44b99187766a141d25d9d1d5e9ceb0 100644 (file)
--- a/hook.c
+++ b/hook.c
@@ -16,8 +16,7 @@ const char *find_hook(struct repository *r, const char *name)
 
        int found_hook;
 
-       strbuf_reset(&path);
-       strbuf_repo_git_path(&path, r, "hooks/%s", name);
+       repo_git_path_replace(r, &path, "hooks/%s", name);
        found_hook = access(path.buf, X_OK) >= 0;
 #ifdef STRIP_EXTENSION
        if (!found_hook) {

diff --git a/path.c b/path.c
index 273b649e00c2d7c9877227773762326a084407b1..779aa94b567a9d7970b64b97981b3f6d1d871a35 100644 (file)
--- a/path.c
+++ b/path.c
@@ -443,14 +443,27 @@ char *repo_git_path(const struct repository *repo,
        return strbuf_detach(&path, NULL);
 }
 
-void strbuf_repo_git_path(struct strbuf *sb,
-                         const struct repository *repo,
-                         const char *fmt, ...)
+const char *repo_git_path_append(const struct repository *repo,
+                                struct strbuf *sb,
+                                const char *fmt, ...)
 {
        va_list args;
        va_start(args, fmt);
        repo_git_pathv(repo, NULL, sb, fmt, args);
        va_end(args);
+       return sb->buf;
+}
+
+const char *repo_git_path_replace(const struct repository *repo,
+                                 struct strbuf *sb,
+                                 const char *fmt, ...)
+{
+       va_list args;
+       strbuf_reset(sb);
+       va_start(args, fmt);
+       repo_git_pathv(repo, NULL, sb, fmt, args);
+       va_end(args);
+       return sb->buf;
 }
 
 char *mkpathdup(const char *fmt, ...)

diff --git a/path.h b/path.h
index 3c75495e1a55e7ce4e3be290c77ae080d872ff39..c45311b0a839a2020a1a81dad19f37338469ca37 100644 (file)
--- a/path.h
+++ b/path.h
@@ -52,29 +52,16 @@ const char *repo_common_path_replace(const struct repository *repo,
  * For an exhaustive list of the adjustments made look at `common_list` and
  * `adjust_git_path` in path.c.
  */
-
-/*
- * Return a path into the git directory of repository `repo`.
- */
 char *repo_git_path(const struct repository *repo,
                    const char *fmt, ...)
        __attribute__((format (printf, 2, 3)));
-
-/*
- * Print a path into the git directory of repository `repo` into the provided
- * buffer.
- */
-void repo_git_pathv(const struct repository *repo,
-                   const struct worktree *wt, struct strbuf *buf,
-                   const char *fmt, va_list args);
-
-/*
- * Construct a path into the git directory of repository `repo` and append it
- * to the provided buffer `sb`.
- */
-void strbuf_repo_git_path(struct strbuf *sb,
-                         const struct repository *repo,
-                         const char *fmt, ...)
+const char *repo_git_path_append(const struct repository *repo,
+                                struct strbuf *sb,
+                                const char *fmt, ...)
+       __attribute__((format (printf, 3, 4)));
+const char *repo_git_path_replace(const struct repository *repo,
+                                 struct strbuf *sb,
+                                 const char *fmt, ...)
        __attribute__((format (printf, 3, 4)));
 
 /*
@@ -241,11 +228,14 @@ struct strbuf *get_pathname(void);
 #  include "strbuf.h"
 #  include "repository.h"
 
-/* Internal implementation detail that should not be used. */
+/* Internal implementation details that should not be used. */
 void repo_common_pathv(const struct repository *repo,
                       struct strbuf *buf,
                       const char *fmt,
                       va_list args);
+void repo_git_pathv(const struct repository *repo,
+                   const struct worktree *wt, struct strbuf *buf,
+                   const char *fmt, va_list args);
 
 /*
  * Return a statically allocated path into the main repository's

diff --git a/submodule.c b/submodule.c
index b361076c5b97a068863a725ae24fc5bbdc472121..211ead54a0f8ae2717ce0856fbeb59697ca7146b 100644 (file)
--- a/submodule.c
+++ b/submodule.c
@@ -1315,7 +1315,7 @@ static int repo_has_absorbed_submodules(struct repository *r)
        int ret;
        struct strbuf buf = STRBUF_INIT;
 
-       strbuf_repo_git_path(&buf, r, "modules/");
+       repo_git_path_append(r, &buf, "modules/");
        ret = file_exists(buf.buf) && !is_empty_dir(buf.buf);
        strbuf_release(&buf);
        return ret;
@@ -2629,6 +2629,6 @@ void submodule_name_to_gitdir(struct strbuf *buf, struct repository *r,
         * administrators can explicitly set. Nothing has been decided,
         * so for now, just append the name at the end of the path.
         */
-       strbuf_repo_git_path(buf, r, "modules/");
+       repo_git_path_append(r, buf, "modules/");
        strbuf_addstr(buf, submodule_name);
 }