diff options
Diffstat (limited to 'doc/libstddjb')
| -rw-r--r-- | doc/libstddjb/djbtime.html | 23 | ||||
| -rw-r--r-- | doc/libstddjb/tai.html | 25 |
2 files changed, 5 insertions, 43 deletions
diff --git a/doc/libstddjb/djbtime.html b/doc/libstddjb/djbtime.html index 7eb5ee4..d20131e 100644 --- a/doc/libstddjb/djbtime.html +++ b/doc/libstddjb/djbtime.html @@ -34,21 +34,6 @@ and implemented in the <tt>libskarnet.a</tt> or <tt>libskarnet.so</tt> library. other time formats and user-friendly representations. </p> -<h2> The <tt>/etc/leapsecs.dat</tt> file </h2> - -<p> - User-friendly time is calculated from UTC. Internal time computations -should be performed on TAI time - because TAI flows linearly whereas -UTC does not. To convert between UTC and TAI time, you need a -<em>leap second table</em>. skalibs provides such a file in its -<tt>src/etc/leapsecs.dat</tt> subdirectory, which is copied -to <tt>/etc/leapsecs.dat</tt> at installation time (unless you specify -a --prefix or --datadir option to configure). -<strong>The <tt>/etc/leapsecs.dat</tt> file must remain accessible -on your system, else time conversions will not be computed -properly.</strong> -</p> - <h2> Data structures </h2> <ul> @@ -72,7 +57,7 @@ Converts the absolute TAI64 time in *<em>t</em> to an UTC time, stored in *<em>u</em> as an unsigned 64-bit integer. *<em>u</em> is actually 2^62 plus the number of seconds since the Epoch. The function returns 1 if it succeeds, or 0 (and sets errno) if an -error occurs (for instance: the leap second table cannot be found). +error occurs. </p> <p> @@ -81,7 +66,7 @@ Converts the UTC time in <em>u</em>, stored as an unsigned 64-bit integer (2^62 plus the number of seconds since the Epoch), to a TAI64 time in *<em>t</em>. The function returns 1 if it succeeds, or 0 (and sets errno) if an -error occurs (for instance: the leap second table cannot be found). +error occurs. </p> <h3> NTP </h3> @@ -92,7 +77,7 @@ Converts the absolute TAI64N time in *<em>a</em> to a 64-bit NTP timestamp, stored in *<em>ntp</em>. The higher 32 bits of *<em>ntp</em> represent a number of seconds ; the lower 32 bits are the fractional part of the timestamp. The function returns 1 if it succeeds, or 0 (and sets errno) if an -error occurs (for instance: the leap second table cannot be found, or +error occurs (for instance: *<em>a</em> cannot be represented in the valid NTP range). </p> @@ -101,7 +86,7 @@ error occurs (for instance: the leap second table cannot be found, or Converts the NTP timestamp in <em>ntp</em> to a TAI64N time in *<em>a</em>. The function returns 1 if it succeeds, or 0 (and sets errno) if an -error occurs (for instance: the leap second table cannot be found). +error occurs. </p> <h3> Local time </h3> diff --git a/doc/libstddjb/tai.html b/doc/libstddjb/tai.html index a285cfb..231c0d1 100644 --- a/doc/libstddjb/tai.html +++ b/doc/libstddjb/tai.html @@ -112,28 +112,6 @@ dates. It is up to the programmer to make sure that a relative time is never interpreted as an absolute TAI64 date, and vice-versa. </p> -<h3> The leap second table </h3> - -<p> - skalibs provides a <tt>src/etc/leapsecs.dat</tt> file, -which is copied to <tt>/etc/leapsecs.dat</tt> at installation time -(or wherever you specified with the <tt>--prefix</tt> or <tt>--datadir</tt> -options to configure). -<strong>Make sure this file is always present and readable.</strong> -This file contains the <em>leap second table</em>, which is needed for -conversions between TAI and UTC. If you call a function that needs such -a conversion (for instance, you call <tt>tain_sysclock()</tt> and your -system clock is set to UTC) and the file cannot be read, the function -call will fail. -</p> - -<p> - The leap second table is read once in every process that needs it -(the first time a TAI ↔ UTC conversion is made) and then is -stored in memory. If the <tt>leapsecs.dat</tt> file changes, long-lived -processes will need to be restarted to take the change into account. -</p> - <h2> Functions </h2> <h3> Wallclock operations </h3> @@ -343,8 +321,7 @@ could not be performed; in which case errno is set to EINVAL if the input argument was not a valid timestamp, to EOVERFLOW if the output could not be represented in the chosen format (which may happen on systems with a 32 bit <tt>time_t</tt>), or other error -codes - for instance related to the leap second table when a -lookup was necessary. +codes. </p> <code> int tai_from_time_sysclock (tai_t *a, time_t t) <br /> |