trace2: update docs to describe system/global config settings

diff --git a/trace2.h b/trace2.h
index 894bfca7e0453ba5307912e4e5414a968808724f..888531eb08380c69d865e0fb00e34bec16e87d2d 100644 (file)
--- a/trace2.h
+++ b/trace2.h
@@ -391,13 +391,19 @@ void trace2_printf(const char *fmt, ...);
  * Optional platform-specific code to dump information about the
  * current and any parent process(es).  This is intended to allow
  * post-processors to know who spawned this git instance and anything
- * else the platform may be able to tell us about the current process.
+ * else that the platform may be able to tell us about the current process.
  */
+
+enum trace2_process_info_reason {
+       TRACE2_PROCESS_INFO_STARTUP,
+       TRACE2_PROCESS_INFO_EXIT,
+};
+
 #if defined(GIT_WINDOWS_NATIVE)
-void trace2_collect_process_info(void);
+void trace2_collect_process_info(enum trace2_process_info_reason reason);
 #else
-#define trace2_collect_process_info() \
-       do {                          \
+#define trace2_collect_process_info(reason) \
+       do {                                \
        } while (0)
 #endif