]> git.ipfire.org Git - thirdparty/git.git/commitdiff
refs: rename `refs_create_symref()` to `refs_update_symref()`
authorKarthik Nayak <karthik.188@gmail.com>
Tue, 7 May 2024 12:58:58 +0000 (14:58 +0200)
committerJunio C Hamano <gitster@pobox.com>
Tue, 7 May 2024 15:51:50 +0000 (08:51 -0700)
The `refs_create_symref()` function is used to update/create a symref.
But it doesn't check the old target of the symref, if existing. It force
updates the symref. In this regard, the name `refs_create_symref()` is a
bit misleading. So let's rename it to `refs_update_symref()`. This is
akin to how 'git-update-ref(1)' also allows us to create apart from
update.

While we're here, rename the arguments in the function to clarify what
they actually signify and reduce confusion.

Signed-off-by: Karthik Nayak <karthik.188@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
builtin/branch.c
builtin/worktree.c
refs.c
refs.h
t/helper/test-ref-store.c

index dd3e3a7dc09541892d4fb86f66f78f5d8038daa0..4491f7a20c962a4e34bcc6dfa2b6a12b3e218847 100644 (file)
@@ -555,7 +555,7 @@ static int replace_each_worktree_head_symref(struct worktree **worktrees,
                        continue;
 
                refs = get_worktree_ref_store(worktrees[i]);
-               if (refs_create_symref(refs, "HEAD", newref, logmsg))
+               if (refs_update_symref(refs, "HEAD", newref, logmsg))
                        ret = error(_("HEAD of working tree %s is not updated"),
                                    worktrees[i]->path);
        }
index 7c6c72536bdb22830d729edf5fa4ac127b4263fb..480202c517006ac59d2c5b24722bfd08d884a7d3 100644 (file)
@@ -517,7 +517,7 @@ static int add_worktree(const char *path, const char *refname,
                ret = refs_update_ref(wt_refs, NULL, "HEAD", &commit->object.oid,
                                      NULL, 0, UPDATE_REFS_MSG_ON_ERR);
        else
-               ret = refs_create_symref(wt_refs, "HEAD", symref.buf, NULL);
+               ret = refs_update_symref(wt_refs, "HEAD", symref.buf, NULL);
        if (ret)
                goto done;
 
diff --git a/refs.c b/refs.c
index 507f5f0525f3f1313a9de842a2231a2ee73f0d2b..fa5471d219b60bb516cb6e2135598e2f4a6aa09b 100644 (file)
--- a/refs.c
+++ b/refs.c
@@ -2284,10 +2284,8 @@ int peel_iterated_oid(const struct object_id *base, struct object_id *peeled)
        return peel_object(base, peeled) ? -1 : 0;
 }
 
-int refs_create_symref(struct ref_store *refs,
-                      const char *ref_target,
-                      const char *refs_heads_master,
-                      const char *logmsg)
+int refs_update_symref(struct ref_store *refs, const char *ref,
+                      const char *target, const char *logmsg)
 {
        struct ref_transaction *transaction;
        struct strbuf err = STRBUF_INIT;
@@ -2295,8 +2293,8 @@ int refs_create_symref(struct ref_store *refs,
 
        transaction = ref_store_transaction_begin(refs, &err);
        if (!transaction ||
-           ref_transaction_update(transaction, ref_target, NULL, NULL,
-                                  refs_heads_master, NULL, REF_NO_DEREF,
+           ref_transaction_update(transaction, ref, NULL, NULL,
+                                  target, NULL, REF_NO_DEREF,
                                   logmsg, &err) ||
            ref_transaction_commit(transaction, &err)) {
                ret = error("%s", err.buf);
@@ -2312,7 +2310,7 @@ int refs_create_symref(struct ref_store *refs,
 int create_symref(const char *ref_target, const char *refs_heads_master,
                  const char *logmsg)
 {
-       return refs_create_symref(get_main_ref_store(the_repository), ref_target,
+       return refs_update_symref(get_main_ref_store(the_repository), ref_target,
                                  refs_heads_master, logmsg);
 }
 
diff --git a/refs.h b/refs.h
index c7851bf587390e3b1269d352ebb9db6bfa1560fa..71cc1c58e000b963ea6f8538a28ed3e1a88f12b3 100644 (file)
--- a/refs.h
+++ b/refs.h
@@ -606,7 +606,7 @@ int refs_copy_existing_ref(struct ref_store *refs, const char *oldref,
 int copy_existing_ref(const char *oldref, const char *newref,
                        const char *logmsg);
 
-int refs_create_symref(struct ref_store *refs, const char *refname,
+int refs_update_symref(struct ref_store *refs, const char *refname,
                       const char *target, const char *logmsg);
 int create_symref(const char *refname, const char *target, const char *logmsg);
 
index 82bbf6e2e68b9b57b8c2d159439631aa36a16d20..4651e4ced71489eca22615295b7af19c9edf2b14 100644 (file)
@@ -118,7 +118,7 @@ static int cmd_create_symref(struct ref_store *refs, const char **argv)
        const char *target = notnull(*argv++, "target");
        const char *logmsg = *argv++;
 
-       return refs_create_symref(refs, refname, target, logmsg);
+       return refs_update_symref(refs, refname, target, logmsg);
 }
 
 static struct flag_definition transaction_flags[] = {