summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCarlos Martín Nieto <cmn@dwim.me>2015-06-23 15:21:12 +0200
committerCarlos Martín Nieto <cmn@dwim.me>2015-06-23 15:21:12 +0200
commitb8323775ca255c6a86572d5295be5c1eeda0b8b3 (patch)
treee6c1e86f95df0000d09c0d61f9c40e56614ef54b
parenta7e7bcd8bf05196fe1ec459188867cc6942ab180 (diff)
downloadlibgit2-cmn/no-grow.tar.gz
blob: don't recomment using git_buf_growcmn/no-grow
We currently recommend using `git_buf_grow` in order to make a buffer make an owned copy of the memory it points to. This is not behaviour we should encourage, so remove this recommendation. The function itself is not changed, as we need to remain compatible, but it will be changed not to allow usage on borrowed buffers.
-rw-r--r--include/git2/blob.h10
1 files changed, 4 insertions, 6 deletions
diff --git a/include/git2/blob.h b/include/git2/blob.h
index c24ff7e7f..4a6d8e50a 100644
--- a/include/git2/blob.h
+++ b/include/git2/blob.h
@@ -107,12 +107,10 @@ GIT_EXTERN(git_off_t) git_blob_rawsize(const git_blob *blob);
* The output is written into a `git_buf` which the caller must free
* when done (via `git_buf_free`).
*
- * If no filters need to be applied, then the `out` buffer will just be
- * populated with a pointer to the raw content of the blob. In that case,
- * be careful to *not* free the blob until done with the buffer. To keep
- * the data detached from the blob, call `git_buf_grow` on the buffer
- * with a `want_size` of 0 and the buffer will be reallocated to be
- * detached from the blob.
+ * If no filters need to be applied, then the `out` buffer will just
+ * be populated with a pointer to the raw content of the blob. In
+ * that case, be careful to *not* free the blob until done with the
+ * buffer or copy it into memory you own.
*
* @param out The git_buf to be filled in
* @param blob Pointer to the blob