Merge branch 'db/text-delta' into svn-fe
[gitweb.git] / vcs-svn / line_buffer.txt
index e89cc41d562448ad65a42b039dcf06a8c38e3335..8e139eb22df0f44ba0b805b374943dd5d12e8437 100644 (file)
@@ -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`
    again
  - removes the temporary file with `buffer_deinit`, perhaps to
@@ -64,19 +64,14 @@ Functions
        Read a line and strip off the trailing newline.
        On failure or end of file, returns NULL.
 
-`buffer_read_string`::
-       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.
-
 `buffer_copy_bytes`::
        Read `len` bytes of input and dump them to the standard output
        stream.  Returns early for error or end of file.
 
 `buffer_skip_bytes`::
        Discards `len` bytes from the input stream (stopping early
-       if necessary because of an error or eof).
+       if necessary because of an error or eof).  Return value is
+       the number of bytes successfully read.
 
 `buffer_reset`::
        Deallocates non-static buffers.