diff options
author | Junio C Hamano <gitster@pobox.com> | 2012-04-09 13:36:20 -0700 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2012-04-09 13:36:20 -0700 |
commit | 8502a779dad784785d9f3d5c880ce08b9ad0f483 (patch) | |
tree | 975d1e72deb75cc91fd75653f50f9fde7db0a7cd /Documentation | |
parent | dbdc07fcbe3a951df8a3869b42edb6fffd466486 (diff) | |
parent | 8a557bb77fc009b00f7952f0d3d6ebd33079f70e (diff) | |
download | git-8502a779dad784785d9f3d5c880ce08b9ad0f483.tar.gz git-8502a779dad784785d9f3d5c880ce08b9ad0f483.tar.xz |
Merge branch 'tr/maint-bundle-long-subject' into maint-1.7.8
* tr/maint-bundle-long-subject:
t5704: match tests to modern style
strbuf: improve strbuf_get*line documentation
bundle: use a strbuf to scan the log for boundary commits
bundle: put strbuf_readline_fd in strbuf.c with adjustments
Diffstat (limited to 'Documentation')
-rw-r--r-- | Documentation/technical/api-strbuf.txt | 18 |
1 files changed, 17 insertions, 1 deletions
diff --git a/Documentation/technical/api-strbuf.txt b/Documentation/technical/api-strbuf.txt index afe275995..95a8bf384 100644 --- a/Documentation/technical/api-strbuf.txt +++ b/Documentation/technical/api-strbuf.txt @@ -255,8 +255,24 @@ same behaviour as well. `strbuf_getline`:: - Read a line from a FILE* pointer. The second argument specifies the line + Read a line from a FILE *, overwriting the existing contents + of the strbuf. The second argument specifies the line terminator character, typically `'\n'`. + Reading stops after the terminator or at EOF. The terminator + is removed from the buffer before returning. Returns 0 unless + there was nothing left before EOF, in which case it returns `EOF`. + +`strbuf_getwholeline`:: + + Like `strbuf_getline`, but keeps the trailing terminator (if + any) in the buffer. + +`strbuf_getwholeline_fd`:: + + Like `strbuf_getwholeline`, but operates on a file descriptor. + It reads one character at a time, so it is very slow. Do not + use it unless you need the correct position in the file + descriptor. `stripspace`:: |