files_ref_store: use a transaction to update packed refs
[gitweb.git] / refs / packed-backend.h
index 03b7c1de95be9387fa0d2165036a4aa6d276d19c..7af2897757f15b120c5264cac1e488bece28b752 100644 (file)
@@ -1,6 +1,15 @@
 #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);