Detail in the manual (method 'file:setvbuf')

ANSI C is vague about 'setvbuf'; most details are implementation
defined. So, the manual cannot give any guaranties, either.
This commit is contained in:
Roberto Ierusalimschy 2019-08-12 11:26:08 -03:00
parent 35a28a58b3
commit 09b4e527a0
1 changed files with 8 additions and 16 deletions

View File

@ -8142,24 +8142,12 @@ end of the file, and returns its size.
@LibEntry{file:setvbuf (mode [, size])|
Sets the buffering mode for an output file.
Sets the buffering mode for a file.
There are three available modes:
@description{
@item{@St{no}|
no buffering; the result of any output operation appears immediately.
}
@item{@St{full}|
full buffering; output operation is performed only
when the buffer is full or when
you explicitly @T{flush} the file @seeF{io.flush}.
}
@item{@St{line}|
line buffering; output is buffered until a newline is output
or there is any input from some special files
(such as a terminal device).
@item{@St{no}| no buffering.}
@item{@St{full}| full buffering.}
@item{@St{line}| line buffering.}
}
}
@ -8167,6 +8155,10 @@ For the last two cases,
@id{size} is a hint for the size of the buffer, in bytes.
The default is an appropriate size.
The specific behavior of each mode is non portable;
check the underlying @ANSI{setvbuf} in your platform for
more details.
}
@LibEntry{file:write (@Cdots)|