refs: pass NULL to refs_resolve_refdup() if hash is not needed
[gitweb.git] / refs / packed-backend.h
index beea9c14b5cb93ce374e3f619d479b116a1108a5..61687e408ad4b83d111531f9d5b10a058abcf673 100644 (file)
@@ -1,22 +1,26 @@
 #ifndef REFS_PACKED_BACKEND_H
 #define REFS_PACKED_BACKEND_H
 
+/*
+ * Support for storing references in a `packed-refs` file.
+ *
+ * Note that this backend doesn't check for D/F conflicts, because it
+ * doesn't care about them. But usually it should be wrapped in a
+ * `files_ref_store` that prevents D/F conflicts from being created,
+ * even among packed refs.
+ */
+
 struct ref_store *packed_ref_store_create(const char *path,
                                          unsigned int store_flags);
 
 /*
  * Lock the packed-refs file for writing. Flags is passed to
- * hold_lock_file_for_update(). Return 0 on success. On errors, set
- * errno appropriately and return a nonzero value.
+ * hold_lock_file_for_update(). Return 0 on success. On errors, write
+ * an error message to `err` and return a nonzero value.
  */
-int lock_packed_refs(struct ref_store *ref_store, int flags);
-
-void add_packed_ref(struct ref_store *ref_store,
-                   const char *refname, const struct object_id *oid);
-
-int commit_packed_refs(struct ref_store *ref_store);
+int packed_refs_lock(struct ref_store *ref_store, int flags, struct strbuf *err);
 
-int repack_without_refs(struct ref_store *ref_store,
-                       struct string_list *refnames, struct strbuf *err);
+void packed_refs_unlock(struct ref_store *ref_store);
+int packed_refs_is_locked(struct ref_store *ref_store);
 
 #endif /* REFS_PACKED_BACKEND_H */