Commit 43288a07 by Ramsay Jones Committed by Shawn O. Pearce

Fixup documentation to reflect the "git_obj" rename

commit dff79e27 renamed
the (small object) "git_sobj" to a plain "git_obj", but
neglected to update some of the documentation to reflect
that change.

Signed-off-by: Ramsay Jones <ramsay@ramsay1.demon.co.uk>
Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
parent ea790f33
...@@ -46,7 +46,7 @@ typedef enum { ...@@ -46,7 +46,7 @@ typedef enum {
GIT_OBJ_REF_DELTA = 7, /**< A delta, base is given by object id. */ GIT_OBJ_REF_DELTA = 7, /**< A delta, base is given by object id. */
} git_otype; } git_otype;
/** A small object read from the database. */ /** An object read from the database. */
typedef struct { typedef struct {
void *data; /**< Raw, decompressed object data. */ void *data; /**< Raw, decompressed object data. */
size_t len; /**< Total number of bytes in data. */ size_t len; /**< Total number of bytes in data. */
...@@ -54,7 +54,7 @@ typedef struct { ...@@ -54,7 +54,7 @@ typedef struct {
} git_obj; } git_obj;
/** /**
* Read a small object from the database. * Read an object from the database.
* *
* If GIT_ENOTFOUND then out->data is set to NULL. * If GIT_ENOTFOUND then out->data is set to NULL.
* *
...@@ -68,7 +68,7 @@ typedef struct { ...@@ -68,7 +68,7 @@ typedef struct {
GIT_EXTERN(int) git_odb_read(git_obj *out, git_odb *db, const git_oid *id); GIT_EXTERN(int) git_odb_read(git_obj *out, git_odb *db, const git_oid *id);
/** /**
* Read a small object from the database using only pack files. * Read an object from the database using only pack files.
* *
* If GIT_ENOTFOUND then out->data is set to NULL. * If GIT_ENOTFOUND then out->data is set to NULL.
* *
...@@ -82,7 +82,7 @@ GIT_EXTERN(int) git_odb_read(git_obj *out, git_odb *db, const git_oid *id); ...@@ -82,7 +82,7 @@ GIT_EXTERN(int) git_odb_read(git_obj *out, git_odb *db, const git_oid *id);
GIT_EXTERN(int) git_odb__read_packed(git_obj *out, git_odb *db, const git_oid *id); GIT_EXTERN(int) git_odb__read_packed(git_obj *out, git_odb *db, const git_oid *id);
/** /**
* Read a small object from the database using only loose object files. * Read an object from the database using only loose object files.
* *
* If GIT_ENOTFOUND then out->data is set to NULL. * If GIT_ENOTFOUND then out->data is set to NULL.
* *
...@@ -96,7 +96,7 @@ GIT_EXTERN(int) git_odb__read_packed(git_obj *out, git_odb *db, const git_oid *i ...@@ -96,7 +96,7 @@ GIT_EXTERN(int) git_odb__read_packed(git_obj *out, git_odb *db, const git_oid *i
GIT_EXTERN(int) git_odb__read_loose(git_obj *out, git_odb *db, const git_oid *id); GIT_EXTERN(int) git_odb__read_loose(git_obj *out, git_odb *db, const git_oid *id);
/** /**
* Release all memory used by the sobj structure. * Release all memory used by the obj structure.
* *
* As a result of this call, obj->data will be set to NULL. * As a result of this call, obj->data will be set to NULL.
* *
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment