Merge branch 'js/check-docs-exe'
[gitweb.git] / refs.h
diff --git a/refs.h b/refs.h
index cc2fb4c68c0e194dc51e3846192911c2c6949c6b..308fa1f03b26c151f2df76a0c4f2f675e7bbee5a 100644 (file)
--- a/refs.h
+++ b/refs.h
@@ -3,8 +3,10 @@
 
 struct object_id;
 struct ref_store;
+struct repository;
 struct strbuf;
 struct string_list;
+struct string_list_item;
 struct worktree;
 
 /*
@@ -274,6 +276,16 @@ struct ref_transaction;
 typedef int each_ref_fn(const char *refname,
                        const struct object_id *oid, int flags, void *cb_data);
 
+/*
+ * The same as each_ref_fn, but also with a repository argument that
+ * contains the repository associated with the callback.
+ */
+typedef int each_repo_ref_fn(struct repository *r,
+                            const char *refname,
+                            const struct object_id *oid,
+                            int flags,
+                            void *cb_data);
+
 /*
  * The following functions invoke the specified callback function for
  * each reference indicated.  If the function ever returns a nonzero
@@ -307,7 +319,7 @@ int for_each_fullref_in(const char *prefix, each_ref_fn fn, void *cb_data,
 int for_each_tag_ref(each_ref_fn fn, void *cb_data);
 int for_each_branch_ref(each_ref_fn fn, void *cb_data);
 int for_each_remote_ref(each_ref_fn fn, void *cb_data);
-int for_each_replace_ref(struct repository *r, each_ref_fn fn, void *cb_data);
+int for_each_replace_ref(struct repository *r, each_repo_ref_fn fn, void *cb_data);
 int for_each_glob_ref(each_ref_fn fn, const char *pattern, void *cb_data);
 int for_each_glob_ref_in(each_ref_fn fn, const char *pattern,
                         const char *prefix, void *cb_data);
@@ -702,9 +714,11 @@ int parse_hide_refs_config(const char *var, const char *value, const char *);
 int ref_is_hidden(const char *, const char *);
 
 enum ref_type {
-       REF_TYPE_PER_WORKTREE,
-       REF_TYPE_PSEUDOREF,
-       REF_TYPE_NORMAL,
+       REF_TYPE_PER_WORKTREE,    /* refs inside refs/ but not shared       */
+       REF_TYPE_PSEUDOREF,       /* refs outside refs/ in current worktree */
+       REF_TYPE_MAIN_PSEUDOREF,  /* pseudo refs from the main worktree     */
+       REF_TYPE_OTHER_PSEUDOREF, /* pseudo refs from other worktrees       */
+       REF_TYPE_NORMAL,          /* normal/shared refs inside refs/        */
 };
 
 enum ref_type ref_type(const char *refname);