[PATCH v2 1/4] strbuf: improve strbuf_get*line documentation
- From
Thomas Rast <trast@student.ethz.ch>
- Date
- Feb 23, 2012, 09:42 UTC
- Message-ID
- <d5522f8d1154321804cb60fb4f53d538242ead88.1329988335.git.trast@student.ethz.ch>
- In-Reply-To
- <cover.1329988335.git.trast@student.ethz.ch>
strbuf_getline() was not documented very clearly, though a reader familiar with getline() would not have had any questions about it. strbuf_getwholeline() was not documented at all.
Signed-off-by: Thomas Rast <trast@student.ethz.ch> --- Documentation/technical/api-strbuf.txt | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-)
diff --git a/Documentation/technical/api-strbuf.txt b/Documentation/technical/api-strbuf.txt index afe2759..cc6db5e 100644 --- a/Documentation/technical/api-strbuf.txt +++ b/Documentation/technical/api-strbuf.txt @@ -255,8 +255,16 @@ same behaviour as well. `strbuf_getline`:: - Read a line from a FILE* pointer. The second argument specifies the line - terminator character, typically `'\n'`. + Read a line from a FILE*. 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. `stripspace`::
-- 1.7.9.1.430.g4998543