Skip to content

Commit 25a33b3

Browse files
avargitster
authored andcommitted
refs API: post-migration API renaming [1/2]
In preceding commits all callers of refs_resolve_ref_unsafe() were migrated to the transitory refs_werrres_ref_unsafe() function. As a first step in getting rid of it let's remove the old function from the public API (it went unused in a preceding commit). We then provide both a coccinelle rule to do the rename, and a macro to avoid breaking the existing callers. Signed-off-by: Ævar Arnfjörð Bjarmason <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 4755d7d commit 25a33b3

File tree

3 files changed

+15
-27
lines changed

3 files changed

+15
-27
lines changed

contrib/coccinelle/refs.pending.cocci

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
@@
2+
expression refs, refname, resolve_flags, oid, flags, failure_errno;
3+
@@
4+
- refs_werrres_ref_unsafe(refs, refname, resolve_flags, oid, flags, failure_errno)
5+
+ refs_resolve_ref_unsafe(refs, refname, resolve_flags, oid, flags, failure_errno)

refs.c

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1669,7 +1669,7 @@ int refs_read_raw_ref(struct ref_store *ref_store, const char *refname,
16691669
type, failure_errno);
16701670
}
16711671

1672-
const char *refs_werrres_ref_unsafe(struct ref_store *refs,
1672+
const char *refs_resolve_ref_unsafe(struct ref_store *refs,
16731673
const char *refname,
16741674
int resolve_flags,
16751675
struct object_id *oid,
@@ -1766,19 +1766,6 @@ const char *refs_werrres_ref_unsafe(struct ref_store *refs,
17661766
return NULL;
17671767
}
17681768

1769-
const char *refs_resolve_ref_unsafe(struct ref_store *refs, const char *refname,
1770-
int resolve_flags, struct object_id *oid,
1771-
int *flags)
1772-
{
1773-
int failure_errno = 0;
1774-
const char *refn;
1775-
refn = refs_werrres_ref_unsafe(refs, refname, resolve_flags,
1776-
oid, flags, &failure_errno);
1777-
if (!refn)
1778-
errno = failure_errno;
1779-
return refn;
1780-
}
1781-
17821769
/* backend functions */
17831770
int refs_init_db(struct strbuf *err)
17841771
{

refs.h

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,6 @@ struct string_list;
1111
struct string_list_item;
1212
struct worktree;
1313

14-
/*
15-
* Callers should not inspect "errno" on failure, but rather pass in a
16-
* "failure_errno" parameter, on failure the "errno" will indicate the
17-
* type of failure encountered, but not necessarily one that came from
18-
* a syscall. We might have faked it up.
19-
*/
20-
const char *refs_werrres_ref_unsafe(struct ref_store *refs,
21-
const char *refname,
22-
int resolve_flags,
23-
struct object_id *oid,
24-
int *flags, int *failure_errno);
25-
2614
/*
2715
* Resolve a reference, recursively following symbolic refererences.
2816
*
@@ -70,16 +58,24 @@ const char *refs_werrres_ref_unsafe(struct ref_store *refs,
7058
* resolved. The function returns NULL for such ref names.
7159
* Caps and underscores refers to the special refs, such as HEAD,
7260
* FETCH_HEAD and friends, that all live outside of the refs/ directory.
61+
*
62+
* Callers should not inspect "errno" on failure, but rather pass in a
63+
* "failure_errno" parameter, on failure the "errno" will indicate the
64+
* type of failure encountered, but not necessarily one that came from
65+
* a syscall. We might have faked it up.
7366
*/
7467
#define RESOLVE_REF_READING 0x01
7568
#define RESOLVE_REF_NO_RECURSE 0x02
7669
#define RESOLVE_REF_ALLOW_BAD_NAME 0x04
7770

71+
#define refs_werrres_ref_unsafe(refs, refname, resolve_flags, oid, flags, failure_errno) \
72+
refs_resolve_ref_unsafe(refs, refname, resolve_flags, oid, flags, failure_errno)
7873
const char *refs_resolve_ref_unsafe(struct ref_store *refs,
7974
const char *refname,
8075
int resolve_flags,
8176
struct object_id *oid,
82-
int *flags);
77+
int *flags, int *failure_errno);
78+
8379
const char *resolve_ref_unsafe(const char *refname, int resolve_flags,
8480
struct object_id *oid, int *flags);
8581

0 commit comments

Comments
 (0)