From: Luke Kenneth Casson Leighton <lkcl@lkcl.net>
Date: Fri, 23 Apr 2021 22:17:11 +0000 (+0100)
Subject: add comments on TestIssuer TestRunner
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=3fdaa03ceb71041b74aab81bf992afbc7a2d2e9e;p=soc.git

add comments on TestIssuer TestRunner
---

diff --git a/src/soc/simple/test/test_issuer.py b/src/soc/simple/test/test_issuer.py
index 3b1fa4e7..ebc529fc 100644
--- a/src/soc/simple/test/test_issuer.py
+++ b/src/soc/simple/test/test_issuer.py
@@ -10,6 +10,12 @@ related bugs:
 
 import unittest
 import sys
+
+# here is the logic which takes test cases and "executes" them.
+# in this instance (TestRunner) its job is to instantiate both
+# a Libre-SOC nmigen-based HDL instance and an ISACaller python
+# simulator.  it's also responsible for performing the single
+# step and comparison.
 from soc.simple.test.test_runner import TestRunner
 
 # test with ALU data and Logical data