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>
next
Patrick Steinhardt 2026-07-02 14:02:04 +02:00 committed by Junio C Hamano
parent aea037e534
commit 8a7ad23e11
1 changed files with 17 additions and 1 deletions

18
odb.h
View File

@ -283,12 +283,28 @@ struct odb_source_info {
} u;
};

/*
* The object info contains the query and response that is to be used for
* functions that end up reading object information. Callers are expected to
* populate pointers whose information they want to request.
*/
struct object_info {
/* Request */
/* The object type. */
enum object_type *typep;

/* The inflated object size in bytes. */
size_t *sizep;

/* The object size as stored on disk. */
off_t *disk_sizep;

/*
* The base the object is deltified against, in case it is stored as a
* delta.
*/
struct object_id *delta_base_oid;

/* The object contents. Ownership of memory goes over to the caller. */
void **contentp;

/*