From 613084629e6973ecfa0197ded5ed857c09bd2a5e Mon Sep 17 00:00:00 2001 From: Laurent Bercot Date: Fri, 19 Dec 2014 02:41:02 +0000 Subject: Documentation fixes --- doc/index.html | 2 ++ doc/libresolv.html | 10 ++++++---- doc/libs6dns/s6dns-ip46.html | 5 +++-- doc/libs6dns/s6dns-resolve.html | 4 ++-- doc/s6-dnsip4-filter.html | 2 +- doc/s6-dnsip6-filter.html | 2 +- doc/s6-dnsname-filter.html | 2 +- doc/skadns/index.html | 7 +++---- 8 files changed, 19 insertions(+), 15 deletions(-) diff --git a/doc/index.html b/doc/index.html index 37ca3ed..11279ed 100644 --- a/doc/index.html +++ b/doc/index.html @@ -76,6 +76,8 @@ point in the future. the previous versions of s6-dns and the current one. +
+

Reference

Commands

diff --git a/doc/libresolv.html b/doc/libresolv.html index c7f07c7..c98b398 100644 --- a/doc/libresolv.html +++ b/doc/libresolv.html @@ -68,9 +68,9 @@ of their dependencies if they need asynchronous DNS resolution.

libs6dns provides several layers of asynchronous interfaces. The user has access to -low-level packet sending +low-level packet sending and receiving, to -synchronous +synchronous resolution of several queries at once, and to a real high-level asynchronous DNS library.

@@ -131,8 +131,10 @@ there has been nothing better so far.

- s6-dns tries to be an alternative solution - not as ambitious, -but based on solid design principles and a reliable code base. + s6-dns tries to be an alternative solution, +based on solid design principles and a reliable code base. +It just works, and it makes DNS resolution nice and easy for +users.

diff --git a/doc/libs6dns/s6dns-ip46.html b/doc/libs6dns/s6dns-ip46.html index 27cbe2c..52b837d 100644 --- a/doc/libs6dns/s6dns-ip46.html +++ b/doc/libs6dns/s6dns-ip46.html @@ -34,8 +34,9 @@ i.e. to be able to work with both IPv4 and IPv6.

If the underlying skalibs -has been compiled with - flag-noipv6, +has been compiled with the + --disable-ipv6 +configure option, or if it has detected at build time that the target host does not support IPv6, then the s6dns-ip46 abstraction will be totally transparent and use no resources at all. diff --git a/doc/libs6dns/s6dns-resolve.html b/doc/libs6dns/s6dns-resolve.html index bad7c15..3a6abcb 100644 --- a/doc/libs6dns/s6dns-resolve.html +++ b/doc/libs6dns/s6dns-resolve.html @@ -35,7 +35,7 @@ to perform high level synchronous DNS resolution. they can block for a non-negligible amount of time. To avoid unbounded waiting times, they always take 2 arguments at the end, deadline and stamp. deadline is the read-only address of a -tain_t +tain_t containing an absolute time which is the deadline for the function, and stamp is the read-write address of a tain_t being an accurate enough representation of the current absolute time. If @@ -355,7 +355,7 @@ It must be in encoded form. A list of valid query types can be found in the s6dns-constants.h header.

  • options : a uint32 containing options passed -to s6dns_engine_init().
    • +to s6dns_engine_init().
  • deadline : a tain_t containing the deadline for this query, i.e. the query will fail with an ETIMEDOUT code if no answer has arrived by then. Note that the deadline diff --git a/doc/s6-dnsip4-filter.html b/doc/s6-dnsip4-filter.html index 5433438..94beb58 100644 --- a/doc/s6-dnsip4-filter.html +++ b/doc/s6-dnsip4-filter.html @@ -101,7 +101,7 @@ argument to s6-dnsq.

    Notes

    - s6-dnsip4-filter does not perform DNS resolutions itself. Instead, if forks + s6-dnsip4-filter does not perform DNS resolutions itself. Instead, it forks a skadnsd child and sends it queries, getting the results asynchronously. The s6-dns filter programs have actually been written as example uses of the skadns library. diff --git a/doc/s6-dnsip6-filter.html b/doc/s6-dnsip6-filter.html index 7cbad6b..56c5ba9 100644 --- a/doc/s6-dnsip6-filter.html +++ b/doc/s6-dnsip6-filter.html @@ -89,7 +89,7 @@ program how a line must be printed. The following sequences are recognized:

    Notes

    - s6-dnsip6-filter does not perform DNS resolutions itself. Instead, if forks + s6-dnsip6-filter does not perform DNS resolutions itself. Instead, it forks a skadnsd child and sends it queries, getting the results asynchronously. The s6-dns filter programs have actually been written as example uses of the skadns library. diff --git a/doc/s6-dnsname-filter.html b/doc/s6-dnsname-filter.html index 1554270..28f10e0 100644 --- a/doc/s6-dnsname-filter.html +++ b/doc/s6-dnsname-filter.html @@ -93,7 +93,7 @@ program how a line must be printed. The following sequences are recognized:

    Notes

    - s6-dnsname-filter does not perform DNS resolutions itself. Instead, if forks + s6-dnsname-filter does not perform DNS resolutions itself. Instead, it forks a skadnsd child and sends it queries, getting the results asynchronously. The s6-dns filter programs have actually been written as example uses of the skadns library. diff --git a/doc/skadns/index.html b/doc/skadns/index.html index f02f2dd..551b341 100644 --- a/doc/skadns/index.html +++ b/doc/skadns/index.html @@ -24,14 +24,13 @@ resolution.

    Compiling

    - -- cgit v1.2.3