mirror of
https://github.com/git/git.git
synced 2024-10-28 12:59:41 +01:00
object.h: expand docstring for lookup_unknown_object()
The lookup_unknown_object() system is not often used and is somewhat confusing. Let's try to explain it a bit more (which is especially important as I'm adding a related but slightly different function in the next commit). Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
parent
b2086b5183
commit
542d6abbb4
1 changed files with 12 additions and 1 deletions
13
object.h
13
object.h
|
@ -144,7 +144,18 @@ struct object *parse_object_or_die(const struct object_id *oid, const char *name
|
|||
*/
|
||||
struct object *parse_object_buffer(struct repository *r, const struct object_id *oid, enum object_type type, unsigned long size, void *buffer, int *eaten_p);
|
||||
|
||||
/** Returns the object, with potentially excess memory allocated. **/
|
||||
/*
|
||||
* Allocate and return an object struct, even if you do not know the type of
|
||||
* the object. The returned object may have its "type" field set to a real type
|
||||
* (if somebody previously called lookup_blob(), etc), or it may be set to
|
||||
* OBJ_NONE. In the latter case, subsequent calls to lookup_blob(), etc, will
|
||||
* set the type field as appropriate.
|
||||
*
|
||||
* Use this when you do not know the expected type of an object and want to
|
||||
* avoid parsing it for efficiency reasons. Try to avoid it otherwise; it
|
||||
* may allocate excess memory, since the returned object must be as large as
|
||||
* the maximum struct of any type.
|
||||
*/
|
||||
struct object *lookup_unknown_object(struct repository *r, const struct object_id *oid);
|
||||
|
||||
struct object_list *object_list_insert(struct object *item,
|
||||
|
|
Loading…
Reference in a new issue