diff options
| author | René Scharfe <rene.scharfe@lsrfire.ath.cx> | 2009-01-06 21:41:14 +0100 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2009-01-06 22:13:43 -0800 |
| commit | 2fc647004ac7016128372a85db8245581e493812 (patch) | |
| tree | 90e0830cc8d31a8ba144857dfcd22e392c2a65d4 /Documentation | |
| parent | 2d642a6f8a5d17db21a60865f8970b9231d34e31 (diff) | |
| download | git-2fc647004ac7016128372a85db8245581e493812.tar.gz git-2fc647004ac7016128372a85db8245581e493812.tar.xz | |
strbuf: instate cleanup rule in case of non-memory errors
Make all strbuf functions that can fail free() their memory on error if
they have allocated it. They don't shrink buffers that have been grown,
though.
This allows for easier error handling, as callers only need to call
strbuf_release() if A) the command succeeded or B) if they would have had
to do so anyway because they added something to the strbuf themselves.
Bonus hunk: document strbuf_readlink.
Signed-off-by: Rene Scharfe <rene.scharfe@lsrfire.ath.cx>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/technical/api-strbuf.txt | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/Documentation/technical/api-strbuf.txt b/Documentation/technical/api-strbuf.txt index a8ee2fe6a..9a4e3ea92 100644 --- a/Documentation/technical/api-strbuf.txt +++ b/Documentation/technical/api-strbuf.txt @@ -133,8 +133,10 @@ Functions * Adding data to the buffer -NOTE: All of these functions in this section will grow the buffer as - necessary. +NOTE: All of the functions in this section will grow the buffer as necessary. +If they fail for some reason other than memory shortage and the buffer hadn't +been allocated before (i.e. the `struct strbuf` was set to `STRBUF_INIT`), +then they will free() it. `strbuf_addch`:: @@ -235,6 +237,11 @@ same behaviour as well. Read the contents of a file, specified by its path. The third argument can be used to give a hint about the file size, to avoid reallocs. +`strbuf_readlink`:: + + Read the target of a symbolic link, specified by its path. The third + argument can be used to give a hint about the size, to avoid reallocs. + `strbuf_getline`:: Read a line from a FILE* pointer. The second argument specifies the line |