undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge branch 'jn/strbuf-doc-re-reuse' into maint

Browse Source 
* jn/strbuf-doc-re-reuse:
  strbuf doc: reuse after strbuf_release is fine
This commit is contained in:
Junio C Hamano 2017-10-18 14:19:13 +09:00
commit 3c905ddd18
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
strbuf.h
View File

@ -82,8 +82,12 @@ extern char strbuf_slopbuf[];
extern void strbuf_init(struct strbuf *, size_t); extern void strbuf_init(struct strbuf *, size_t);
/** /**
* Release a string buffer and the memory it used. You should not use the * Release a string buffer and the memory it used. After this call, the
* string buffer after using this function, unless you initialize it again. * 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 *); 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 * 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 * storage the string occupies and it is your responsibility from then on
* to release it with `free(3)` when you are done with it. * 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 *); extern char *strbuf_detach(struct strbuf *, size_t *);