time: split absolute and relative times.

[ccan] / ccan / time / _info

diff --git a/ccan/time/_info b/ccan/time/_info
index c562e49f11069d85d8b4caf187dae712d05c0487..5cf20f79611a85e3322b4b08b0ae57dadd547efb 100644 (file)
--- a/ccan/time/_info
+++ b/ccan/time/_info
@@ -4,7 +4,9 @@
 /**
  * time - routines for dealing with time
  *
- * This code provides convenient functions for working with time.
+ * This code provides convenient functions for working with time, in the
+ * form of 'struct timerel' for durations and 'struct timeabs' for timestamps
+ * which are light wrappers around struct timespec.
  *
  * Author: Rusty Russell <rusty@rustcorp.com.au>
  * License: BSD-MIT
@@ -17,19 +19,19 @@
  *
  *     int main(int argc, char *argv[])
  *     {
- *             struct timespec t;
+ *             struct timeabs t;
  *
  *             if (argc != 2)
  *                     errx(1, "Usage: %s <diff in millisec>", argv[0]);
  *
  *             t = time_now();
  *             if (argv[1][0] == '-')
- *                     t = time_sub(t, time_from_msec(atol(argv[1]+1)));
+ *                     t = timeabs_sub(t, time_from_msec(atol(argv[1]+1)));
  *             else
- *                     t = time_add(t, time_from_msec(atol(argv[1])));
+ *                     t = timeabs_add(t, time_from_msec(atol(argv[1])));
  *
  *             printf("%lu.%09u\n",
- *                    (unsigned long)t.tv_sec, (unsigned)t.tv_nsec);
+ *                    (unsigned long)t.ts.tv_sec, (unsigned)t.ts.tv_nsec);
  *             return 0;
  *     }
  */