diff options
| author | Carlos Martín Nieto <cmn@dwim.me> | 2013-08-17 01:55:52 +0200 |
|---|---|---|
| committer | Carlos Martín Nieto <cmn@dwim.me> | 2013-08-17 02:02:28 +0200 |
| commit | 7a3764bee92456e5ee2ed41be9abb0ffb4165eb7 (patch) | |
| tree | 99fc4b012880da2a61260e6aa0d28ecf0fe8fe81 /include/git2/sys | |
| parent | fe0c6d4e712fa1bb072b8a847783bad47f3e91eb (diff) | |
| download | libgit2-7a3764bee92456e5ee2ed41be9abb0ffb4165eb7.tar.gz | |
odb: document git_odb_stream
Clarify the role of each function and in particular mention that there
is no need for the backend or stream to worry about the object's id,
as it will be given when `finalize_write` is called.
Diffstat (limited to 'include/git2/sys')
| -rw-r--r-- | include/git2/sys/odb_backend.h | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/include/git2/sys/odb_backend.h b/include/git2/sys/odb_backend.h index 2d06613d2..31ffe1c33 100644 --- a/include/git2/sys/odb_backend.h +++ b/include/git2/sys/odb_backend.h @@ -48,6 +48,10 @@ struct git_odb_backend { int (* read_header)( size_t *, git_otype *, git_odb_backend *, const git_oid *); + /** + * Write an object into the backend. The id of the object has + * already been calculated and is passed in. + */ int (* write)( git_odb_backend *, const git_oid *, const void *, size_t, git_otype); |