documentation: add brief mention of cat-file to tutorial part I
[git/debian.git] / refs.h
blobfa816c1e9f58ca1ab1c1b434b01786a0f3b0a41e
1 #ifndef REFS_H
2 #define REFS_H
4 /*
5 * Calls the specified function for each ref file until it returns nonzero,
6 * and returns the value
7 */
8 extern int head_ref(int (*fn)(const char *path, const unsigned char *sha1));
9 extern int for_each_ref(int (*fn)(const char *path, const unsigned char *sha1));
10 extern int for_each_tag_ref(int (*fn)(const char *path, const unsigned char *sha1));
11 extern int for_each_branch_ref(int (*fn)(const char *path, const unsigned char *sha1));
12 extern int for_each_remote_ref(int (*fn)(const char *path, const unsigned char *sha1));
14 /** Reads the refs file specified into sha1 **/
15 extern int get_ref_sha1(const char *ref, unsigned char *sha1);
17 /** Locks ref and returns the fd to give to write_ref_sha1() if the ref
18 * has the given value currently; otherwise, returns -1.
19 **/
20 extern int lock_ref_sha1(const char *ref, const unsigned char *old_sha1);
22 /** Writes sha1 into the refs file specified, locked with the given fd. **/
23 extern int write_ref_sha1(const char *ref, int fd, const unsigned char *sha1);
25 /** Writes sha1 into the refs file specified. **/
26 extern int write_ref_sha1_unlocked(const char *ref, const unsigned char *sha1);
28 /** Returns 0 if target has the right format for a ref. **/
29 extern int check_ref_format(const char *target);
31 #endif /* REFS_H */