diff options
| author | Russell Belfer <rb@github.com> | 2013-09-09 10:24:48 -0700 |
|---|---|---|
| committer | Russell Belfer <rb@github.com> | 2013-09-09 10:24:48 -0700 |
| commit | 4dfe38205b7ddd255c87ff4656720072991fc432 (patch) | |
| tree | 0c74fef4259d37568351fbf5fb80c9f6cf18e767 /include/git2/odb.h | |
| parent | 5fb1f9f2040df47ace275ab974b41d00883aef75 (diff) | |
| download | libgit2-4dfe38205b7ddd255c87ff4656720072991fc432.tar.gz | |
Comment updates
Diffstat (limited to 'include/git2/odb.h')
| -rw-r--r-- | include/git2/odb.h | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/include/git2/odb.h b/include/git2/odb.h index e50a2a1c1..3bd18e782 100644 --- a/include/git2/odb.h +++ b/include/git2/odb.h @@ -223,7 +223,8 @@ GIT_EXTERN(int) git_odb_write(git_oid *out, git_odb *odb, const void *data, size * won't be effective until `git_odb_stream_finalize_write` is called * and returns without an error * - * The stream must always be free'd or will leak memory. + * The stream must always be freed when done with `git_odb_stream_free` or + * will leak memory. * * @see git_odb_stream * @@ -238,8 +239,8 @@ GIT_EXTERN(int) git_odb_open_wstream(git_odb_stream **out, git_odb *db, size_t s /** * Write to an odb stream * - * This method will fail as soon as the total number of - * received bytes exceeds the size declared with `git_odb_open_wstream()` + * This method will fail if the total number of received bytes exceeds the + * size declared with `git_odb_open_wstream()` * * @param stream the stream * @param buffer the data to write |