8 unsigned char old_sha1
[20];
13 #define REF_ISSYMREF 01
14 #define REF_ISPACKED 02
17 * Calls the specified function for each ref file until it returns nonzero,
18 * and returns the value
20 typedef int each_ref_fn(const char *refname
, const unsigned char *sha1
, int flags
, void *cb_data
);
21 extern int head_ref(each_ref_fn
, void *);
22 extern int for_each_ref(each_ref_fn
, void *);
23 extern int for_each_ref_in(const char *, each_ref_fn
, void *);
24 extern int for_each_tag_ref(each_ref_fn
, void *);
25 extern int for_each_branch_ref(each_ref_fn
, void *);
26 extern int for_each_remote_ref(each_ref_fn
, void *);
27 extern int for_each_replace_ref(each_ref_fn
, void *);
28 extern int for_each_glob_ref(each_ref_fn
, const char *pattern
, void *);
29 extern int for_each_glob_ref_in(each_ref_fn
, const char *pattern
, const char* prefix
, void *);
31 extern int head_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
);
32 extern int for_each_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
);
33 extern int for_each_ref_in_submodule(const char *submodule
, const char *prefix
,
34 each_ref_fn fn
, void *cb_data
);
35 extern int for_each_tag_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
);
36 extern int for_each_branch_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
);
37 extern int for_each_remote_ref_submodule(const char *submodule
, each_ref_fn fn
, void *cb_data
);
39 extern int head_ref_namespaced(each_ref_fn fn
, void *cb_data
);
40 extern int for_each_namespaced_ref(each_ref_fn fn
, void *cb_data
);
42 static inline const char *has_glob_specials(const char *pattern
)
44 return strpbrk(pattern
, "?*[");
47 /* can be used to learn about broken ref and symref */
48 extern int for_each_rawref(each_ref_fn
, void *);
50 extern void warn_dangling_symref(FILE *fp
, const char *msg_fmt
, const char *refname
);
53 * Extra refs will be listed by for_each_ref() before any actual refs
54 * for the duration of this process or until clear_extra_refs() is
55 * called. Only extra refs added before for_each_ref() is called will
56 * be listed on a given call of for_each_ref().
58 extern void add_extra_ref(const char *refname
, const unsigned char *sha1
, int flags
);
59 extern void clear_extra_refs(void);
60 extern int ref_exists(const char *);
62 extern int peel_ref(const char *refname
, unsigned char *sha1
);
64 /** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
65 extern struct ref_lock
*lock_ref_sha1(const char *refname
, const unsigned char *old_sha1
);
67 /** Locks any ref (for 'HEAD' type refs). */
68 #define REF_NODEREF 0x01
69 extern struct ref_lock
*lock_any_ref_for_update(const char *refname
,
70 const unsigned char *old_sha1
,
73 /** Close the file descriptor owned by a lock and return the status */
74 extern int close_ref(struct ref_lock
*lock
);
76 /** Close and commit the ref locked by the lock */
77 extern int commit_ref(struct ref_lock
*lock
);
79 /** Release any lock taken but not written. **/
80 extern void unlock_ref(struct ref_lock
*lock
);
82 /** Writes sha1 into the ref specified by the lock. **/
83 extern int write_ref_sha1(struct ref_lock
*lock
, const unsigned char *sha1
, const char *msg
);
86 * Invalidate the reference cache for the specified submodule. Use
87 * submodule=NULL to invalidate the cache for the main module. This
88 * function must be called if references are changed via a mechanism
89 * other than the refs API.
91 extern void invalidate_ref_cache(const char *submodule
);
93 /** Setup reflog before using. **/
94 int log_ref_setup(const char *ref_name
, char *logfile
, int bufsize
);
96 /** Reads log for the value of ref during at_time. **/
97 extern int read_ref_at(const char *refname
, unsigned long at_time
, int cnt
,
98 unsigned char *sha1
, char **msg
,
99 unsigned long *cutoff_time
, int *cutoff_tz
, int *cutoff_cnt
);
101 /* iterate over reflog entries */
102 typedef int each_reflog_ent_fn(unsigned char *osha1
, unsigned char *nsha1
, const char *, unsigned long, int, const char *, void *);
103 int for_each_reflog_ent(const char *refname
, each_reflog_ent_fn fn
, void *cb_data
);
104 int for_each_recent_reflog_ent(const char *refname
, each_reflog_ent_fn fn
, long, void *cb_data
);
107 * Calls the specified function for each reflog file until it returns nonzero,
108 * and returns the value
110 extern int for_each_reflog(each_ref_fn
, void *);
112 #define REFNAME_ALLOW_ONELEVEL 1
113 #define REFNAME_REFSPEC_PATTERN 2
114 #define REFNAME_DOT_COMPONENT 4
117 * Return 0 iff refname has the correct format for a refname according
118 * to the rules described in Documentation/git-check-ref-format.txt.
119 * If REFNAME_ALLOW_ONELEVEL is set in flags, then accept one-level
120 * reference names. If REFNAME_REFSPEC_PATTERN is set in flags, then
121 * allow a "*" wildcard character in place of one of the name
122 * components. No leading or repeated slashes are accepted. If
123 * REFNAME_DOT_COMPONENT is set in flags, then allow refname
124 * components to start with "." (but not a whole component equal to
127 extern int check_refname_format(const char *refname
, int flags
);
129 extern const char *prettify_refname(const char *refname
);
130 extern char *shorten_unambiguous_ref(const char *refname
, int strict
);
132 /** rename ref, return 0 on success **/
133 extern int rename_ref(const char *oldref
, const char *newref
, const char *logmsg
);
136 * Resolve refname in the nested "gitlink" repository that is located
137 * at path. If the resolution is successful, return 0 and set sha1 to
138 * the name of the object; otherwise, return a non-zero value.
140 extern int resolve_gitlink_ref(const char *path
, const char *refname
, unsigned char *sha1
);
142 /** lock a ref and then write its file */
143 enum action_on_err
{ MSG_ON_ERR
, DIE_ON_ERR
, QUIET_ON_ERR
};
144 int update_ref(const char *action
, const char *refname
,
145 const unsigned char *sha1
, const unsigned char *oldval
,
146 int flags
, enum action_on_err onerr
);