From 76e4960aa9b9badbd9caa376e303f9360ebb7ccd Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Thu, 18 Dec 2014 23:30:55 +0000 Subject: Documentation fixes --- doc/crosscompile.html | 6 ++++-- doc/flags.html | 12 ++++++++---- doc/libskarnet.html | 8 ++++---- doc/libstddjb/djbunix.html | 2 +- doc/libstddjb/genwrite.html | 2 +- doc/libstddjb/iopause.html | 2 +- doc/libstddjb/safewrappers.html | 2 +- doc/libunixonacid/skaclient.html | 34 ++++++++++++++++++++++++++++++++++ 8 files changed, 54 insertions(+), 14 deletions(-) (limited to 'doc') diff --git a/doc/crosscompile.html b/doc/crosscompile.html index ba22b31..4098afd 100644 --- a/doc/crosscompile.html +++ b/doc/crosscompile.html @@ -76,8 +76,10 @@ architecture, via the --with-sysdeps option to configure.

The easiest way to get the correct sysdeps for a target achitecture is -to natively compile skalibs on that target, and steal the produced sysdeps -files. It can be easily done with a virtual machine, qemu for instance. +to natively run skalibs' ./configure script on that target, +and steal the produced sysdeps files, which are normally written to the +./sysdeps.cfg directory. +Doing this is easy with a virtual machine, qemu for instance. You could also (politely) ask for precompiled sysdeps on the skaware mailing-list, if you cannot find them anywhere on the Internet.

diff --git a/doc/flags.html b/doc/flags.html index 2579d5a..2357445 100644 --- a/doc/flags.html +++ b/doc/flags.html @@ -43,6 +43,10 @@ symbolic link to point to skalibs-$v to the installed skalibs shared libraries. +

+ If this option is not given, no slashpackage support will be provided. +

+

--enable-libc-replacements

@@ -260,8 +264,8 @@ support.

If you don't set this option, then skalibs will include IPv6 support in the -relevant networking functions, if the target architecture supports it. -The safe option is to let this flag clear. +relevant networking functions if and only if the target architecture supports it. +This is the default, and it is safe.

--enable-force-devr

@@ -275,9 +279,9 @@ its autodetection.

Otherwise, /dev/random will be autodetected and tested; if entropy generation is low on the host, the compilation -process might hang for several minutes. It is safe to let this flag +process might hang for several minutes. It is safe to leave this flag clear; it should only be set to speed up the compilation process in a -known environment and for testing purposes. +known environment or for testing purposes.

diff --git a/doc/libskarnet.html b/doc/libskarnet.html index 9c29514..6c8b559 100644 --- a/doc/libskarnet.html +++ b/doc/libskarnet.html @@ -60,14 +60,14 @@ to run ldconfig if needed. installed: by default, it's /usr/lib/skalibs/sysdeps. Let's call it $sysdeps.

  • Link with -lskarnet. If you are using socket functions, you -will also need to link with -l$sysdeps/socket.lib. If you are using +will also need to link with -l`cat $sysdeps/socket.lib`. If you are using time functions such as tain_now(), you will also need to link with --l$sysdeps/tainnow.lib.
    • +-l`cat $sysdeps/tainnow.lib`.

    - The skarnet library as a whole is big (833k for libskarnet.a and -257k for libskarnet.so.2.0.0.0 on x86_64), but the utmost care has been + The skarnet library as a whole is big (826k for libskarnet.a and +233k for libskarnet.so.2.0.0.0 on x86_64-linux), but the utmost care has been given to separate functions so that linkers never pull in any more than they need. Linking against the static version of libskarnet actually produces very small executables, and if your libc is suited for that, since skalibs diff --git a/doc/libstddjb/djbunix.html b/doc/libstddjb/djbunix.html index 37235c1..02f8624 100644 --- a/doc/libstddjb/djbunix.html +++ b/doc/libstddjb/djbunix.html @@ -465,7 +465,7 @@ The parent's end of the pipe will be stored in *fd.

    - pid_t child_spawn1_socket (char const *file, char const *const *argv, char const *const *envp, int *fd) + pid_t child_spawn1_socket (char const *file, char const *const *argv, char const *const *envp, int *fd)
    Like child_spawn0, except that a socket is created between the parent and the child. Both the child's stdin and stdout point to the socket; the parent has its end of the socket available in *fd. diff --git a/doc/libstddjb/genwrite.html b/doc/libstddjb/genwrite.html index 33ff4d3..3bf6fd8 100644 --- a/doc/libstddjb/genwrite.html +++ b/doc/libstddjb/genwrite.html @@ -46,7 +46,7 @@ stuff to the target without flushing it (which can be genwrite_put_stralloc, genwrite_put_buffer, genwrite_put_bufalloc or any compatible user-defined function) in .put, a pointer to a function -that flushes the target (which can be genwrite_flush_stralloc, +that flushes the target (which can be genwrite_flush_stralloc, genwrite_flush_buffer, genwrite_flush_bufalloc or any compatible user-defined function) in .flush, and a pointer to the target writing structure in .target. diff --git a/doc/libstddjb/iopause.html b/doc/libstddjb/iopause.html index 72eedde..da6ff48 100644 --- a/doc/libstddjb/iopause.html +++ b/doc/libstddjb/iopause.html @@ -188,7 +188,7 @@ if it is available; but if it is not, then iopause_poll defaults to which has a more comfortable API than select(), but a maximum precision of 1 millisecond which might not be enough for some applications; whereas -iopause_select defaults to select(), which incurs some CPU overhead for the +iopause_select defaults to select(), which incurs some CPU overhead for the API conversion, but has a 1 microsecond precision.

    diff --git a/doc/libstddjb/safewrappers.html b/doc/libstddjb/safewrappers.html index 37d2425..da8608b 100644 --- a/doc/libstddjb/safewrappers.html +++ b/doc/libstddjb/safewrappers.html @@ -70,7 +70,7 @@ signal is caught. And that means SA_RESTART should not be used.

    - Which means that other system calls performed when the signal handler has + Which also means that other system calls performed when the signal handler has been installed, for instance in the body of the loop, will not be protected, and can return -1 EINTR if a signal is caught at the wrong time.

    diff --git a/doc/libunixonacid/skaclient.html b/doc/libunixonacid/skaclient.html index 7deb38b..f4b3020 100644 --- a/doc/libunixonacid/skaclient.html +++ b/doc/libunixonacid/skaclient.html @@ -26,6 +26,40 @@ and implemented in the libskarnet.a or libskarnet.so library.

    General information

    +

    + skaclient is a client-server initiation protocol framework, allowing a process +(the "client") to either connect to another process (the "server") via a Unix domain socket, +or spawn such a "server" process itself. The client and the server then communicate +via two sockets, one for synchronous data, the other for asynchronous +data; they exchange unixmessages. +

    + +

    + The skaclient framework is used in several places in skarnet.org software, +whenever a server can send asynchronous data to its client. For instance: +

    + +
      +
    • Communication between notification subscribers such as +s6-ftrig-wait +and their own s6-ftrigrd +daemon
      • +
    • Communication between clients of the +s6lock library and a +s6lockd +server
      • +
    • Communication between a client such as +s6-dnsip4-filter, +in need of asynchronous DNS service, and its own +skadnsd +daemon
      • +
    • The skabus Unix bus +infrastructure is entirely based on the skaclient framework to transmit +unixmessages across processes.
      • +
    + +

    Programming

    +

    FIXME: to be completed.

    -- cgit v1.3.1