From 593f36aec7434a6355fbcf822623f82c75a9cfd5 Mon Sep 17 00:00:00 2001
From: Mark Pizzolato <mark@infocomm.com>
Date: Tue, 4 Feb 2020 16:09:33 -0800
Subject: [PATCH] SCP: Add explanatory comments in sim_rev.h

---
 sim_rev.h | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/sim_rev.h b/sim_rev.h
index 02bc902b..fe4a6423 100644
--- a/sim_rev.h
+++ b/sim_rev.h
@@ -48,6 +48,14 @@
 #include ".git-commit-id.h"
 #endif
 
+/*
+  Simh's git commit id would be undefined when working with an 
+  extracted archive (zip file or tar ball).  To address this 
+  problem and record the commit id that the archive was created 
+  from, the archive creation process populates the below 
+  information as a consequence of the "sim_rev.h export-subst" 
+  line in the .gitattributes file.
+ */
 #if !defined(SIM_GIT_COMMIT_ID)
 #define SIM_GIT_COMMIT_ID $Format:%H$
 #define SIM_GIT_COMMIT_TIME $Format:%aI$