pktmr: BREAKING more denominations

1 files changed, 9 insertions, 0 deletions

diff --git a/pk.h.in b/pk.h.in
index ddc897e..db5a720 100644
--- a/pk.h.in
+++ b/pk.h.in
@@ -175,6 +175,15 @@
 *
 * Offers a set of `pk_tmr*` macros for elapsed time checking.
 *
+* The following definitions (shown with defaults) can be overridden:
+* PK_TMR_CLOCK               CLOCK_MONOTONIC
+*
+* If your needs require you to use more than one clock, I recommend calling
+*  `clock_gettime` manually instead of calling `pk_tmr_start`/`pk_tmr_stop`.
+* `pk_tmr.b` is the start time.
+* `pk_tmr.e` end the end time.
+* You could then call the `pk_tmr_duration...` convenience macros as needed.
+*
 *******************************************************************************/
 
 #define PK_VERSION "@@PK_VERSION@@"