odb: document object info fields
Some of the fields in `struct object_info` are undocumented. Add these missing comments. Signed-off-by: Patrick Steinhardt <ps@pks.im> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Patrick Steinhardt committed
Jul 2, 2026 at 14:02 UTC
8a7ad23e11de9a1de0d16a3aaddb840be768ab30
1 file changed
+17
-1
odb.h
+17
-1
@@ -283,12 +283,28 @@ struct odb_source_info {
283
} u;
284
};
285
286
+/*
287
+ * The object info contains the query and response that is to be used for
288
+ * functions that end up reading object information. Callers are expected to
289
+ * populate pointers whose information they want to request.
290
+ */
291
struct object_info {
287
- /* Request */
292
+ /* The object type. */
293
enum object_type *typep;
294
+
295
+ /* The inflated object size in bytes. */
296
size_t *sizep;
297
+
298
+ /* The object size as stored on disk. */
299
off_t *disk_sizep;
300
+
301
+ /*
302
+ * The base the object is deltified against, in case it is stored as a
303
+ * delta.
304
+ */
305
struct object_id *delta_base_oid;
306
+
307
+ /* The object contents. Ownership of memory goes over to the caller. */
308
void **contentp;
309
310
/*