Document expected ISO8601 time formats in ABI header

Document the expected ISO8601 time formats in the ABI header to justify
the choice of string maximum length.

Signed-off-by: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
Change-Id: I4dedde83b5fb81c376245338773ea63677401a09

diff --git a/include/lttng/abi.h b/include/lttng/abi.h
index 40317e86c5f89e20811434ced24b9aed46aae564..02bcefaea5cf87abc686b821bd37351807f73666 100644 (file)
--- a/include/lttng/abi.h
+++ b/include/lttng/abi.h
@@ -22,6 +22,13 @@
 
 #define LTTNG_KERNEL_ABI_SYM_NAME_LEN          256
 #define LTTNG_KERNEL_ABI_SESSION_NAME_LEN      256
+
+/*
+ * The expected iso8601 time formats are either:
+ *
+ * - YYYYmmddTHHMMSS+HHMM           (20 characters + \0)
+ * - YYYY-mm-ddTHH:MM:SS+HH:MM      (25 characters + \0)
+ */
 #define LTTNG_KERNEL_ABI_SESSION_CREATION_TIME_ISO8601_LEN     26
 
 enum lttng_kernel_abi_instrumentation {