diff options
author | Junio C Hamano <gitster@pobox.com> | 2017-10-07 10:27:53 +0300 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2017-10-07 10:27:53 +0300 |
commit | aae4788eee306cd4923b765cc4768fee2e7ca13e (patch) | |
tree | 84c377cfd270d42a99fe9c3ecf751add30984a54 | |
parent | 436b35942cb5198a8d5e915690e65ee1c860baf2 (diff) | |
parent | e0222159fa53ea24785cfb1dc5de0214e89b0117 (diff) |
Merge branch 'jn/strbuf-doc-re-reuse'
* jn/strbuf-doc-re-reuse:
strbuf doc: reuse after strbuf_release is fine
-rw-r--r-- | strbuf.h | 11 |
1 files changed, 9 insertions, 2 deletions
@@ -82,8 +82,12 @@ extern char strbuf_slopbuf[]; extern void strbuf_init(struct strbuf *, size_t); /** - * Release a string buffer and the memory it used. You should not use the - * string buffer after using this function, unless you initialize it again. + * Release a string buffer and the memory it used. After this call, the + * strbuf points to an empty string that does not need to be free()ed, as + * if it had been set to `STRBUF_INIT` and never modified. + * + * To clear a strbuf in preparation for further use without the overhead + * of free()ing and malloc()ing again, use strbuf_reset() instead. */ extern void strbuf_release(struct strbuf *); @@ -91,6 +95,9 @@ extern void strbuf_release(struct strbuf *); * Detach the string from the strbuf and returns it; you now own the * storage the string occupies and it is your responsibility from then on * to release it with `free(3)` when you are done with it. + * + * The strbuf that previously held the string is reset to `STRBUF_INIT` so + * it can be reused after calling this function. */ extern char *strbuf_detach(struct strbuf *, size_t *); |