[PATCH] Add a bit of developer documentation to pull.h
[git.git] / refs.h
blob60cf48086f61c9206a343425ba9fdae3dce62937
1 #ifndef REFS_H
2 #define REFS_H
4 /** Reads the refs file specified into sha1 **/
5 extern int get_ref_sha1(const char *ref, unsigned char *sha1);
7 /** Locks ref and returns the fd to give to write_ref_sha1() if the ref
8 * has the given value currently; otherwise, returns -1.
9 **/
10 extern int lock_ref_sha1(const char *ref, const unsigned char *old_sha1);
12 /** Writes sha1 into the refs file specified, locked with the given fd. **/
13 extern int write_ref_sha1(const char *ref, int fd, const unsigned char *sha1);
15 /** Writes sha1 into the refs file specified. **/
16 extern int write_ref_sha1_unlocked(const char *ref, const unsigned char *sha1);
18 /** Returns 0 if target has the right format for a ref. **/
19 extern int check_ref_format(const char *target);
21 #endif /* REFS_H */