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: I9f649e90ff14389e5ad5be1c9d0c3c6f3846a242

diff --git a/lttng-abi.h b/lttng-abi.h
index 51d60e5be8ce13d14f4a520cc53f16440b959e35..9d6595f72c0b3eeb57173958262bb41ca0f7c3e9 100644 (file)
--- a/lttng-abi.h
+++ b/lttng-abi.h
@@ -21,6 +21,13 @@
 
 #define LTTNG_KERNEL_SYM_NAME_LEN      256
 #define LTTNG_KERNEL_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_SESSION_CREATION_TIME_ISO8601_LEN 26
 
 enum lttng_kernel_instrumentation {