From e92e5cbc9c42a7f926eb4b25fdf6e52ec9d2fa4c Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Mon, 28 Apr 2025 08:44:56 +0000 Subject: Update docs to latest posix version Signed-off-by: Laurent Bercot --- doc/libstddjb/alarm.html | 8 ++++---- doc/libstddjb/alloc.html | 2 +- doc/libstddjb/allreadwrite.html | 20 ++++++++++---------- doc/libstddjb/bytestr.html | 2 +- doc/libstddjb/cspawn.html | 6 +++--- doc/libstddjb/djbunix.html | 26 +++++++++++++------------- doc/libstddjb/env.html | 2 +- doc/libstddjb/index.html | 6 +++--- doc/libstddjb/iopause.html | 10 +++++----- doc/libstddjb/lolstdio.html | 14 +++++++------- doc/libstddjb/safewrappers.html | 8 ++++---- doc/libstddjb/selfpipe.html | 4 ++-- doc/libstddjb/tai.html | 10 +++++----- 13 files changed, 59 insertions(+), 59 deletions(-) (limited to 'doc/libstddjb') diff --git a/doc/libstddjb/alarm.html b/doc/libstddjb/alarm.html index cf673f6..00d2838 100644 --- a/doc/libstddjb/alarm.html +++ b/doc/libstddjb/alarm.html @@ -29,18 +29,18 @@ and implemented in the libskarnet.a or libskarnet.so library.

alarm is a set of primitives to provide the same functionality as -alarm(), +alarm(), but with sub-second precision.

Depending on the functionality the underlying system provides, the precision can be 1 nanosecond (implementation via -timer_settime(), +timer_settime(), 1 microsecond (implementation via -setitimer(), +setitimer(), or 1 second (fallback implementation with -alarm() +alarm() when nothing better can be found).

diff --git a/doc/libstddjb/alloc.html b/doc/libstddjb/alloc.html index 646a206..b110b61 100644 --- a/doc/libstddjb/alloc.html +++ b/doc/libstddjb/alloc.html @@ -30,7 +30,7 @@ and implemented in the libskarnet.a or libskarnet.so library.

alloc is the skalibs heap memory manager. It's actually a wrapper for the -malloc() +malloc() series of functions; it unifies a few system-dependent malloc behaviours. It's also the API to implement and preload if for some reason you need to plug in your own allocator: replacing alloc() diff --git a/doc/libstddjb/allreadwrite.html b/doc/libstddjb/allreadwrite.html index 9ad14de..3f580e9 100644 --- a/doc/libstddjb/allreadwrite.html +++ b/doc/libstddjb/allreadwrite.html @@ -46,17 +46,17 @@ use higher-level APIs such as buffer and

typedef ssize_t io_func (int fd, char *buf, size_t len)
This is the simplified type of IO functions such as -read() +read() and -write(). +write().

typedef ssize_t iov_func (int fd, struct iovec const *v, unsigned int vlen)
This is the simplified type of IO functions such as -readv() +readv() and -writev(), +writev(), where the content to perform IO on is specified as a scatter/gather array of vlen elements instead of a single string. @@ -122,42 +122,42 @@ elements instead of a single string.

ssize_t fd_read (int fd, char *s, size_t len)
Safe wrapper around the -read() +read() function.

ssize_t fd_write (int fd, char const *s, size_t len)
Safe wrapper around the -write() +write() function.

ssize_t fd_readv (int fd, struct iovec const *v, unsigned int vlen)
Safe wrapper around the -readv() +readv() function.

ssize_t fd_writev (int fd, struct iovec const *v, unsigned int vlen)
Safe wrapper around the -writev() +writev() function.

ssize_t fd_recv (int fd, char *s, size_t len, unsigned int flags)
Safe wrapper around the -recv() +recv() function.

ssize_t fd_send (int fd, char const *s, size_t len, unsigned int flags)
Safe wrapper around the -send() +send() function.

diff --git a/doc/libstddjb/bytestr.html b/doc/libstddjb/bytestr.html index 951712b..1daf39c 100644 --- a/doc/libstddjb/bytestr.html +++ b/doc/libstddjb/bytestr.html @@ -30,7 +30,7 @@ and implemented in the libskarnet.a or libskarnet.so library.

These functions handle arrays of bytes (strings). They are similar to their counterparts from the standard - string.h + string.h header, but they return indices instead of pointers.

diff --git a/doc/libstddjb/cspawn.html b/doc/libstddjb/cspawn.html index 73096df..3316e41 100644 --- a/doc/libstddjb/cspawn.html +++ b/doc/libstddjb/cspawn.html @@ -29,10 +29,10 @@ and implemented in the libskarnet.a or libskarnet.so library.

cspawn is a unifier API to spawn child processes with -posix_spawn() +posix_spawn() as a backend if supported by the system, falling back on -fork() + -execve() +fork() + +execve() otherwise.

diff --git a/doc/libstddjb/djbunix.html b/doc/libstddjb/djbunix.html index 63eca54..18af549 100644 --- a/doc/libstddjb/djbunix.html +++ b/doc/libstddjb/djbunix.html @@ -71,21 +71,21 @@ Returns 0 if it succeeds, or -1 (and sets errno) if it fails.

int pipenb (int *p)
Like -pipe(), +pipe(), but both ends of the created pipe are in non-blocking mode.

int pipecoe (int *p)
Like -pipe(), +pipe(), but both ends of the created pipe are close-on-exec.

int pipenbcoe (int *p)
Like -pipe(), +pipe(), but both ends of the created pipe are in non-blocking mode and close-on-exec.

@@ -123,32 +123,32 @@ Returns 0 if it succeeds, or -1 (and sets errno) if it fails. void fd_close (int fd)
Closes fd. This is a safe wrapper around -close(). +close().

int fd_chmod (int fd, unsigned int mode)
Safe wrapper around -fchmod(). +fchmod().

int fd_chown (int fd, uid_t uid, gid_t gid)
Safe wrapper around -fchown(). +fchown(). This function requires root privileges.

int fd_sync (int fd)
Safe wrapper around -fsync(). +fsync().

int fd_chdir (int fd)
Safe wrapper around -fchdir(). +fchdir().

@@ -196,7 +196,7 @@ Returns 1 if it succeeds and 0 if it fails. Shuts down socket fd, for reading if w is zero, and for writing otherwise. Does not return an error code; does not modify errno. This is just a call to -shutdown() +shutdown() with errno saved, used essentially to isolate application code from sys/socket.h which is a portability nightmare.

@@ -227,14 +227,14 @@ Returns -1 (and sets errno) if an error occurs.

int open2 (char const *file, unsigned int flags)
Safe wrapper around -open() +open() when it takes 2 arguments.

int open3 (char const *file, unsigned int flags, unsigned int mode)
Safe wrapper around -open() +open() when it takes 3 arguments.

@@ -267,7 +267,7 @@ Returns a valid fd number if it succeeds, or -1 (and sets errno) if it fails. Opens file in read-only, blocking mode. Returns a valid fd number if it succeeds, or -1 (and sets errno) if it fails. This call does not block. The -open() +open() system call is actually performed with the O_NONBLOCK option, and blocking mode is set afterwards; this behaviour allows for more transparent interactions with FIFOs. @@ -413,7 +413,7 @@ or -1 (and sets errno) if it fails.

pid_t waitpid_nointr (pid_t pid, int *wstat, int flags)
Safe wrapper around -waitpid(). +waitpid().

diff --git a/doc/libstddjb/env.html b/doc/libstddjb/env.html index aff9257..9fe2885 100644 --- a/doc/libstddjb/env.html +++ b/doc/libstddjb/env.html @@ -55,7 +55,7 @@ environment variables, or to remove them from the environment.

char const *env_get (char const *s)
Deprecated alias of -getenv(). +getenv().

diff --git a/doc/libstddjb/index.html b/doc/libstddjb/index.html index 2e25056..b67620d 100644 --- a/doc/libstddjb/index.html +++ b/doc/libstddjb/index.html @@ -45,7 +45,7 @@ including them directly.

Programming