xz: Add a comment clarifying the use of start_time in mytime.c.

1 files changed, 5 insertions, 0 deletions

diff --git a/src/xz/mytime.c b/src/xz/mytime.c
index 8d5e994..917eff0 100644
--- a/src/xz/mytime.c
+++ b/src/xz/mytime.c
@@ -20,6 +20,11 @@
 
 uint64_t opt_flush_timeout = 0;
 
+// The start_time variable will not represent the actual start time
+// if mytime_sigtstp_handler() executes. The signal handler measures
+// the amount of time spent stopped and adds it to start_time.
+// So, care must be taken in the future if the actual start time needs
+// to be displayed for any reason.
 #ifdef USE_SIGTSTP_HANDLER
 static volatile uint64_t start_time;
 #else