Commit 43288a0733c1dc0a506a1e45087bb7f9bd87d047
2008-11-29T19:18:43
Fixup documentation to reflect the "git_obj" rename commit dff79e27d3d2cdc09790ded80fe2ea8ff5d61034 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>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
diff --git a/src/git/odb.h b/src/git/odb.h
index ca98405..07f4f5f 100644
--- a/src/git/odb.h
+++ b/src/git/odb.h
@@ -46,7 +46,7 @@ typedef enum {
GIT_OBJ_REF_DELTA = 7, /**< A delta, base is given by object id. */
} git_otype;
-/** A small object read from the database. */
+/** An object read from the database. */
typedef struct {
void *data; /**< Raw, decompressed object data. */
size_t len; /**< Total number of bytes in data. */
@@ -54,7 +54,7 @@ typedef struct {
} 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.
*
@@ -68,7 +68,7 @@ typedef struct {
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.
*
@@ -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);
/**
- * 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.
*
@@ -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);
/**
- * 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.
*