From 38fef1782f48f8870c27594431294990ca792a5f Mon Sep 17 00:00:00 2001 From: abejgonzalez Date: Wed, 25 Sep 2019 13:50:22 -0700 Subject: [PATCH 1/2] add firrtl interpreter to the docs [ci skip] --- docs/Tools/Treadle.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/Tools/Treadle.rst b/docs/Tools/Treadle.rst index 19df75de..9e3d6154 100644 --- a/docs/Tools/Treadle.rst +++ b/docs/Tools/Treadle.rst @@ -1,5 +1,7 @@ -Treadle +Treadle and FIRRTL Interpreter ============================== -`Treadle `__ is a circuit simulator that directly executes FIRRTL. -It is especially useful for interactive debugging and small unit tests that benefit from a low-overhead simulator. +`Treadle `__ and `FIRRTL Interpreter `__ +are circuit simulators that directly execute FIRRTL (specifically low-firrtl IR). +They are especially useful for interactive debugging and many of projects within Chipyard +use them for a low-overhead simulator. From beae2cfcf9de642a1d8ed58254c6157f41855780 Mon Sep 17 00:00:00 2001 From: abejgonzalez Date: Wed, 25 Sep 2019 16:38:09 -0700 Subject: [PATCH 2/2] emphasize that firrtl-interpreter is deprecated | mention smaller modules [ci skip] --- docs/Tools/Treadle.rst | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/Tools/Treadle.rst b/docs/Tools/Treadle.rst index 9e3d6154..4c6d016c 100644 --- a/docs/Tools/Treadle.rst +++ b/docs/Tools/Treadle.rst @@ -1,7 +1,9 @@ Treadle and FIRRTL Interpreter ============================== -`Treadle `__ and `FIRRTL Interpreter `__ +`Treadle `__ and +`FIRRTL Interpreter `__ are circuit simulators that directly execute FIRRTL (specifically low-firrtl IR). -They are especially useful for interactive debugging and many of projects within Chipyard -use them for a low-overhead simulator. +Treadle is the replacement for FIRRTL Interpreter but FIRRTL Interpreter is still used within some +projects. Treadle is useful for simulating modules in a larger SoC design. Many projects +use Treadle for interactive debugging and a low-overhead simulator.