aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2025-12-18 06:07:03 +0000
committerLaurent Bercot <ska-skaware@skarnet.org>2025-12-18 06:07:03 +0000
commitf1cc42ff92f561f6cb768b4b4aa9a5ec71ccb6e3 (patch)
tree83e7b6f1d67d7733ab1dea2b69e0062130bd29a9 /doc
parente8c4f5f36537c236820857168e66bc07dae2846e (diff)
downloadskalibs-f1cc42ff92f561f6cb768b4b4aa9a5ec71ccb6e3.tar.gz
buffer doc: some adjustments. Credit Hoël.
Diffstat (limited to 'doc')
-rw-r--r--doc/libstddjb/buffer.html7
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/libstddjb/buffer.html b/doc/libstddjb/buffer.html
index 000e0e3..eac7003 100644
--- a/doc/libstddjb/buffer.html
+++ b/doc/libstddjb/buffer.html
@@ -29,8 +29,9 @@ and implemented in the <tt>libskarnet.a</tt> or <tt>libskarnet.so</tt> library.
<p>
skalibs provides convenience structures and functions to perform buffered I/O.
-These structures and functions abstract and replace, from a programer’s point
-of vue, direct calls to fd_read or fd_write for instance.
+These structures and functions abstract direct calls to <tt>read</tt> or <tt>write</tt>;
+they're meant to be used in place of <tt>stdio.h</tt> primitives. Unlike <tt>stdio</tt>,
+they can be used with non-blocking file descriptors.
</p>
<p>
@@ -84,7 +85,7 @@ fails.
<p>
The above are the most important and fundamental functions for buffering.
Other functions can be found in the same header and their prototypes are
-self-explaining.
+self-explaining. More may be documented here later.
</p>
</body>