From d1611f81badf54aaf460ba37f01dc98c4005d82a Mon Sep 17 00:00:00 2001
From: chick
Date: Tue, 9 Feb 2016 11:24:08 -0800
Subject: Added support for finish method of BasicTester to be overridden in a
 subclass which allows tester to have clean up and other construction code
 executed after a user code executed during constructor of that subclass

---
 src/main/scala/Chisel/testers/BasicTester.scala | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'src/main/scala/Chisel/testers/BasicTester.scala')

diff --git a/src/main/scala/Chisel/testers/BasicTester.scala b/src/main/scala/Chisel/testers/BasicTester.scala
index 6807a30e..98033486 100644
--- a/src/main/scala/Chisel/testers/BasicTester.scala
+++ b/src/main/scala/Chisel/testers/BasicTester.scala
@@ -24,4 +24,6 @@ class BasicTester extends Module {
       pushCommand(Stop(Node(clock), 0))
     }
   }
+
+  def finish(): Unit = {}
 }
-- 
cgit v1.2.3


From 82da362037a227a1c16eb56ead69f3f73cea6c4f Mon Sep 17 00:00:00 2001
From: chick
Date: Wed, 10 Feb 2016 12:11:51 -0800
Subject: Added some comments describing potential use of the finish method
 hook clean up the test example

---
 src/main/scala/Chisel/testers/BasicTester.scala | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'src/main/scala/Chisel/testers/BasicTester.scala')

diff --git a/src/main/scala/Chisel/testers/BasicTester.scala b/src/main/scala/Chisel/testers/BasicTester.scala
index 98033486..8f4d60f4 100644
--- a/src/main/scala/Chisel/testers/BasicTester.scala
+++ b/src/main/scala/Chisel/testers/BasicTester.scala
@@ -25,5 +25,10 @@ class BasicTester extends Module {
     }
   }
 
+  /** Called this class or a subclass's constructor has finished giving
+    * developers of chisel testers a post construction hook.
+    * For example, a decoupled tester subclassing BasicTester could override finish in order to
+    * add flow control logic around loading the device under test's input io from a Vec of values
+    */
   def finish(): Unit = {}
 }
-- 
cgit v1.2.3


From a9355ba3784e3c5ae611f096a48b4ee5c78464ad Mon Sep 17 00:00:00 2001
From: chick
Date: Wed, 10 Feb 2016 14:29:49 -0800
Subject: TesterDriverSpec is simpler and cleaner, extraneous circuit has been
 removed. Cleanup comment for finish method in BasicTester, and finishWrapper
 in TesterDriver.

---
 src/main/scala/Chisel/testers/BasicTester.scala | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

(limited to 'src/main/scala/Chisel/testers/BasicTester.scala')

diff --git a/src/main/scala/Chisel/testers/BasicTester.scala b/src/main/scala/Chisel/testers/BasicTester.scala
index 8f4d60f4..d3e9e7c8 100644
--- a/src/main/scala/Chisel/testers/BasicTester.scala
+++ b/src/main/scala/Chisel/testers/BasicTester.scala
@@ -25,10 +25,10 @@ class BasicTester extends Module {
     }
   }
 
-  /** Called this class or a subclass's constructor has finished giving
-    * developers of chisel testers a post construction hook.
-    * For example, a decoupled tester subclassing BasicTester could override finish in order to
-    * add flow control logic around loading the device under test's input io from a Vec of values
+  /** The finish method provides a hook that subclasses of BasicTester can use to
+    * alter a circuit after their constructor has been called.
+    * For example, a specialized tester subclassing BasicTester could override finish in order to
+    * add flow control logic for a decoupled io port of a device under test
     */
   def finish(): Unit = {}
 }
-- 
cgit v1.2.3