]>
git.ipfire.org Git - thirdparty/git.git/blob - refs.h
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 *);
30 /* can be used to learn about broken ref and symref */
31 extern int for_each_rawref(each_ref_fn
, void *);
33 extern void warn_dangling_symref(FILE *fp
, const char *msg_fmt
, const char *refname
);
36 * Extra refs will be listed by for_each_ref() before any actual refs
37 * for the duration of this process or until clear_extra_refs() is
38 * called. Only extra refs added before for_each_ref() is called will
39 * be listed on a given call of for_each_ref().
41 extern void add_extra_ref(const char *refname
, const unsigned char *sha1
, int flags
);
42 extern void clear_extra_refs(void);
44 extern int peel_ref(const char *, unsigned char *);
46 /** Locks a "refs/" ref returning the lock on success and NULL on failure. **/
47 extern struct ref_lock
*lock_ref_sha1(const char *ref
, const unsigned char *old_sha1
);
49 /** Locks any ref (for 'HEAD' type refs). */
50 #define REF_NODEREF 0x01
51 extern struct ref_lock
*lock_any_ref_for_update(const char *ref
, const unsigned char *old_sha1
, int flags
);
53 /** Close the file descriptor owned by a lock and return the status */
54 extern int close_ref(struct ref_lock
*lock
);
56 /** Close and commit the ref locked by the lock */
57 extern int commit_ref(struct ref_lock
*lock
);
59 /** Release any lock taken but not written. **/
60 extern void unlock_ref(struct ref_lock
*lock
);
62 /** Writes sha1 into the ref specified by the lock. **/
63 extern int write_ref_sha1(struct ref_lock
*lock
, const unsigned char *sha1
, const char *msg
);
65 /** Reads log for the value of ref during at_time. **/
66 extern int read_ref_at(const char *ref
, unsigned long at_time
, int cnt
, unsigned char *sha1
, char **msg
, unsigned long *cutoff_time
, int *cutoff_tz
, int *cutoff_cnt
);
68 /* iterate over reflog entries */
69 typedef int each_reflog_ent_fn(unsigned char *osha1
, unsigned char *nsha1
, const char *, unsigned long, int, const char *, void *);
70 int for_each_reflog_ent(const char *ref
, each_reflog_ent_fn fn
, void *cb_data
);
71 int for_each_recent_reflog_ent(const char *ref
, each_reflog_ent_fn fn
, long, void *cb_data
);
74 * Calls the specified function for each reflog file until it returns nonzero,
75 * and returns the value
77 extern int for_each_reflog(each_ref_fn
, void *);
79 #define CHECK_REF_FORMAT_OK 0
80 #define CHECK_REF_FORMAT_ERROR (-1)
81 #define CHECK_REF_FORMAT_ONELEVEL (-2)
82 #define CHECK_REF_FORMAT_WILDCARD (-3)
83 extern int check_ref_format(const char *target
);
85 extern const char *prettify_refname(const char *refname
);
86 extern char *shorten_unambiguous_ref(const char *ref
, int strict
);
88 /** rename ref, return 0 on success **/
89 extern int rename_ref(const char *oldref
, const char *newref
, const char *logmsg
);
91 /** resolve ref in nested "gitlink" repository */
92 extern int resolve_gitlink_ref(const char *name
, const char *refname
, unsigned char *result
);
94 /** lock a ref and then write its file */
95 enum action_on_err
{ MSG_ON_ERR
, DIE_ON_ERR
, QUIET_ON_ERR
};
96 int update_ref(const char *action
, const char *refname
,
97 const unsigned char *sha1
, const unsigned char *oldval
,
98 int flags
, enum action_on_err onerr
);