summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonathan Nieder <jrnieder@gmail.com>2020-01-03 16:13:31 -0800
committerJunio C Hamano <gitster@pobox.com>2020-01-06 08:44:24 -0800
commit60440d72db4c9f2fc05b841813e72159c4f08928 (patch)
tree2bc28ab59a2138996ad102578c7e4947aa222a66
parent53a06cf39b756eddfe4a2a34da93e3d04eb7b728 (diff)
downloadgit-60440d72db4c9f2fc05b841813e72159c4f08928.tar.gz
sha1-file: document how to use pretend_object_file
Like in-memory alternates, pretend_object_file contains a trap for the unwary: careless callers can use it to create references to an object that does not exist in the on-disk object store. Add a comment documenting how to use the function without risking such problems. The only current caller is blame, which uses pretend_object_file to create an in-memory commit representing the working tree state. Noticed during a discussion of how to safely use this function in operations like "git merge" which, unlike blame, are not read-only. Inspired-by: Junio C Hamano <gitster@pobox.com> Signed-off-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--object-store.h8
1 files changed, 8 insertions, 0 deletions
diff --git a/object-store.h b/object-store.h
index 7f7b3cdd80..f91e0c99b4 100644
--- a/object-store.h
+++ b/object-store.h
@@ -187,6 +187,14 @@ int hash_object_file_literally(const void *buf, unsigned long len,
const char *type, struct object_id *oid,
unsigned flags);
+/*
+ * Add an object file to the in-memory object store, without writing it
+ * to disk.
+ *
+ * Callers are responsible for calling write_object_file to record the
+ * object in persistent storage before writing any other new objects
+ * that reference it.
+ */
int pretend_object_file(void *, unsigned long, enum object_type,
struct object_id *oid);