path: root/vcs-svn/line_buffer.txt
diff options
authorJonathan Nieder <>2011-03-25 04:09:19 (GMT)
committerJonathan Nieder <>2011-03-26 05:17:35 (GMT)
commit7e2fe3a9fc816391b322ad9b3f2adf9342631db6 (patch)
treedfff25606bdefe49287d379f2e3bc538af1013d3 /vcs-svn/line_buffer.txt
parente7d04ee147dcbe6af1fa1d2147466696e2be31bc (diff)
vcs-svn: remove buffer_read_string
All previous users of buffer_read_string have already been converted to use the more intuitive buffer_read_binary, so remove the old API to avoid some confusion. Signed-off-by: Jonathan Nieder <>
Diffstat (limited to 'vcs-svn/line_buffer.txt')
1 files changed, 3 insertions, 9 deletions
diff --git a/vcs-svn/line_buffer.txt b/vcs-svn/line_buffer.txt
index 4ef0755..8e139eb 100644
--- a/vcs-svn/line_buffer.txt
+++ b/vcs-svn/line_buffer.txt
@@ -16,8 +16,8 @@ The calling program:
- initializes a `struct line_buffer` to LINE_BUFFER_INIT
- specifies a file to read with `buffer_init`
- - processes input with `buffer_read_line`, `buffer_read_string`,
- `buffer_skip_bytes`, and `buffer_copy_bytes`
+ - processes input with `buffer_read_line`, `buffer_skip_bytes`,
+ and `buffer_copy_bytes`
- closes the file with `buffer_deinit`, perhaps to start over and
read another file.
@@ -37,7 +37,7 @@ the calling program. A program
the temporary file
- declares writing is over with `buffer_tmpfile_prepare_to_read`
- can re-read what was written with `buffer_read_line`,
- `buffer_read_string`, and so on
+ `buffer_copy_bytes`, and so on
- can reuse the temporary file by calling `buffer_tmpfile_rewind`
- removes the temporary file with `buffer_deinit`, perhaps to
@@ -64,12 +64,6 @@ Functions
Read a line and strip off the trailing newline.
On failure or end of file, returns NULL.
- Read `len` characters of input or up to the end of the
- file, whichever comes first. Returns NULL on error.
- Returns whatever characters were read (possibly "")
- for end of file.
Read `len` bytes of input and dump them to the standard output
stream. Returns early for error or end of file.