From f3d5157564992f1ef9f390b3ce0c7d3706ba0f19 Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Sun, 4 Oct 2020 01:06:16 +0000 Subject: doc: fix URLs --- doc/djblegacy.html | 6 +++--- doc/flags.html | 12 ++++++------ doc/index.html | 4 ++-- doc/libbiguint/index.html | 7 ++----- doc/librandom/index.html | 4 ++-- doc/libskarnet.html | 2 +- doc/libstddjb/alarm.html | 8 ++++---- doc/libstddjb/alloc.html | 2 +- doc/libstddjb/allreadwrite.html | 12 ++++++------ doc/libstddjb/djbtime.html | 2 +- doc/libstddjb/djbunix.html | 32 ++++++++++++++++---------------- doc/libstddjb/gccattributes.html | 2 +- doc/libstddjb/index.html | 10 +++++----- doc/libstddjb/iopause.html | 14 +++++++------- doc/libstddjb/lolstdio.html | 14 +++++++------- doc/libstddjb/safewrappers.html | 8 ++++---- doc/libstddjb/selfpipe.html | 6 +++--- doc/libstddjb/tai.html | 26 +++++++++++++------------- doc/license.html | 2 +- doc/upgrade.html | 6 +++--- 20 files changed, 88 insertions(+), 91 deletions(-) diff --git a/doc/djblegacy.html b/doc/djblegacy.html index 6073497..dcf27cc 100644 --- a/doc/djblegacy.html +++ b/doc/djblegacy.html @@ -21,9 +21,9 @@

Who is this DJB guy, and why is he so special anyway ?

-Dan J. Bernstein is a cryptologist and +Dan J. Bernstein is a cryptologist and a mathematician; he's also the author of a widely known and used MTA, -qmail, as well as a few +qmail, as well as a few lesser known pieces of software.

@@ -98,7 +98,7 @@ What do you do? interfaces, even if it amounts to cramming a square peg into a round hole. This is why buffer overflows exist. This is why people use abominations such as -gets(), +gets(), which is still in the Single Unix Specification as of version 4, in freaking June 2011. This is why the System V initialization scheme is still prevalent in Linux distributions, diff --git a/doc/flags.html b/doc/flags.html index 7aa8f95..2f89068 100644 --- a/doc/flags.html +++ b/doc/flags.html @@ -27,7 +27,7 @@ uncommon options; this page explains what they are for.

This flag tells configure that you want to install skalibs according to -the slashpackage convention. +the slashpackage convention. If you enable it, and $v is the version of skalibs you're compiling, make install will install the skalibs header files in /package/prog/skalibs-$v/include, the static libraries in @@ -63,11 +63,11 @@ to the installed skalibs shared libraries.

To understand what this flag is about - and the next two flags too - you should start by reading -this +this page about Unix time, -which David Madore wrote after +which David Madore wrote after a long and fairly complete discussion we had on the subject. You can also -read what DJB says about Unix time. +read what DJB says about Unix time. Unfortunately, when he says "the POSIX rules are so outrageously dumb (...) that no self-respecting engineer would obey them", DJB is wrong: a lot of people follow the POSIX rules. Or maybe he's right... and there are very, @@ -85,7 +85,7 @@ uncommon, thing to do:

diff --git a/doc/libbiguint/index.html b/doc/libbiguint/index.html index 101b7b7..f0378dd 100644 --- a/doc/libbiguint/index.html +++ b/doc/libbiguint/index.html @@ -24,7 +24,7 @@ operations on (unsigned) integers of arbitrary length. It is nowhere near as powerful or efficient as specialized, assembly language-optimized libraries such as -GMP, but it has the advantages +GMP, but it has the advantages of smallness and simplicity.

@@ -381,10 +381,7 @@ The functions return 1 if all went well. bu_invmod() computes the inverse of c modulo m and stores it into c.
The divisor and m must be relatively prime, else -those functions return 0 EDOM.
- The algorithm for modular division and inversion is due to -Sheueling -Chang Shantz. +those functions return 0 EDOM.

diff --git a/doc/librandom/index.html b/doc/librandom/index.html index cd27bed..b141b59 100644 --- a/doc/librandom/index.html +++ b/doc/librandom/index.html @@ -109,8 +109,8 @@ available random generator provided by the underlying system. By decreasing order of preference, it will use the following implementations if available: diff --git a/doc/libskarnet.html b/doc/libskarnet.html index 82f381d..5ff9154 100644 --- a/doc/libskarnet.html +++ b/doc/libskarnet.html @@ -68,7 +68,7 @@ time functions such as tain_now(), you will also need to link with timer.lib for timer_create functions, and so on. This is, unfortunately, the only way to work with all the idiosyncrasies and whimsies of various libcs; only -musl does the sensible thing and +musl does the sensible thing and exports all its functions from libc.a and libc.so, without requiring any additional linker command line flags. diff --git a/doc/libstddjb/alarm.html b/doc/libstddjb/alarm.html index c5d0218..a6cc748 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 ca6ecf1..646a206 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 0dd5ea0..2619153 100644 --- a/doc/libstddjb/allreadwrite.html +++ b/doc/libstddjb/allreadwrite.html @@ -46,9 +46,9 @@ use higher-level APIs such as buffer and

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

@@ -97,28 +97,28 @@ set errno to EWOULDBLOCK or EAGAIN.

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_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/djbtime.html b/doc/libstddjb/djbtime.html index 724cd66..8d47b5c 100644 --- a/doc/libstddjb/djbtime.html +++ b/doc/libstddjb/djbtime.html @@ -30,7 +30,7 @@ and implemented in the libskarnet.a or libskarnet.so library.

djbtime is a set of functions to convert tai_t and tain_t structures, and -TAI time, from and to +TAI time, from and to other time formats and user-friendly representations.

diff --git a/doc/libstddjb/djbunix.html b/doc/libstddjb/djbunix.html index 6223bf4..2e99dd0 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().

@@ -165,7 +165,7 @@ supported:

@@ -236,14 +236,14 @@ modifying errno.

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)
Safe wrapper around -open() +open() when it takes 3 arguments.

@@ -264,7 +264,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. @@ -336,8 +336,8 @@ The function returns if it fails, and sets errno appropriately. pathexec_run() is the standard skalibs API to perform an exec call with a path search. It is recommended that you use it instead of the Single Unix -execvp() or -execlp() +execvp() or +execlp() functions, because execvp and execlp default to execution of the /bin/sh interpreter with file as an argument if they cannot find a suitable executable file, and this is: @@ -439,7 +439,7 @@ and the grandchild's PID if the current process is the parent. pid_t child_spawn0 (char const *file, char const *const *argv, char const *const *envp)
Forks and executes a child as with pathexec_run(file, argv, envp). Returns 0 if it fails, and the pid of the child if it succeeds. -Implemented via posix_spawn() +Implemented via posix_spawn() on systems that support it.

@@ -522,7 +522,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/gccattributes.html b/doc/libstddjb/gccattributes.html index 194edc9..fa604be 100644 --- a/doc/libstddjb/gccattributes.html +++ b/doc/libstddjb/gccattributes.html @@ -22,7 +22,7 @@

skalibs/gccattributes.h is a set of wrappers around -gcc +gcc attributes (duh). It defines macros that are always valid, and that have no effect if the compiler is not gcc or the used version of gcc does not support the wanted attribute. diff --git a/doc/libstddjb/index.html b/doc/libstddjb/index.html index d7b6ad1..7851ba9 100644 --- a/doc/libstddjb/index.html +++ b/doc/libstddjb/index.html @@ -45,7 +45,7 @@ including them directly.

Programming

-

Hey, Linux has signalfd() for this !

+

Hey, Linux has signalfd() for this !

Yes, the Linux team loves to gratuitously add new system calls to do diff --git a/doc/libstddjb/tai.html b/doc/libstddjb/tai.html index efd4346..d3eaa1d 100644 --- a/doc/libstddjb/tai.html +++ b/doc/libstddjb/tai.html @@ -50,21 +50,21 @@ understand what is going on:

The meat and potatoes of all this is that programmers cannot simply rely on standard Unix APIs such as -gettimeofday() +gettimeofday() (which, by the way, is marked as obsolescent, but it's not going to disappear tomorrow) to measure time intervals or even to give precise absolute time, and in any case those APIs will become obsolete in 2038. @@ -74,7 +74,7 @@ any case those APIs will become obsolete in 2038.

tai implements - among other things - the -TAI64 and TAI64N +TAI64 and TAI64N formats, which are used in all of skalibs. This gives a programmer access to precise linear absolute time, which is suitable for both timestamping (wallclock usage) and time interval measurements @@ -84,7 +84,7 @@ represent dates exceeding the estimated lifespan of the universe).

tai has been inspired by Dan J. Bernstein's -libtai library, but does not +libtai library, but does not borrow any code from it.

@@ -96,10 +96,10 @@ precision. A tain_t structure holds an absolute date with a maximum of one-nanosecond precision, as permitted by the underlying system call. If flag-usert is clear, the system clock will be read via -gettimeofday() +gettimeofday() system call, which has a one-microsecond precision; if it is set, the system clock will be read via the -clock_gettime() +clock_gettime() system call, which has a one-nanosecond precision. In either case, a current tain_t will be unable to be more precise than the underlying implementation. @@ -180,7 +180,7 @@ start of a program.

The following two operations can only succeed if your system provides the -clock_gettime() +clock_gettime() primitive with at least one of the CLOCK_MONOTONIC or CLOCK_BOOTTIME clocks. Otherwise, they will fail with errno set to ENOSYS.

@@ -333,7 +333,7 @@ depending on whether skalibs was compiled with the --enable-tai-clock configure option). This is useful to get valid TAI/TAI64N timestamps out of information exported by the system, for instance the time_t -returned by time(), +returned by time(), or in the st_atim, st_mtim or st_ctim fields of a struct stat.

@@ -427,14 +427,14 @@ Those functions return nonzero iff *t1 is lesser than *t2. Marshals *t into the buffer s points to, which must be preallocated with at least TAI_PACK (8) characters. Afterwards, the buffer contains the -external TAI64 format +external TAI64 format representation of *t.

void tai_unpack (char const *s, tai_t *t)
Unmarshals the -external TAI64 format +external TAI64 format label pointed to by s (at least TAI_PACK characters) and stores the result into t.

@@ -443,7 +443,7 @@ the result into t. void tain_pack (char *s, tain_t const *a)
void tain_unpack (char const *s, tain_t *a)
Same thing with -external TAI64N format, +external TAI64N format, using TAIN_PACK (12) characters.

diff --git a/doc/license.html b/doc/license.html index 3293fef..27bbf9f 100644 --- a/doc/license.html +++ b/doc/license.html @@ -22,7 +22,7 @@

The skalibs source code from skalibs is released under the -ISC license, +ISC license, the text of which can be found in the COPYING file enclosed in the package.

diff --git a/doc/upgrade.html b/doc/upgrade.html index accabdc..e59df35 100644 --- a/doc/upgrade.html +++ b/doc/upgrade.html @@ -68,7 +68,7 @@ Currently, that means one: --with-sysdep-devurandom=yes or
  • New functions:
    • @@ -163,7 +163,7 @@ families of functions, have been removed. @@ -341,7 +341,7 @@ types. Main benefit: correct 64-bit support on 64-bit archs with 32-bit int.
  • The child_spawn* family of functions now resets all signals to their default values when spawning a program on systems with -posix_spawn(). +posix_spawn(). This should not change anything - it's just paranoia.
  • Minor bugfixes.
    • -- cgit v1.2.3