From: lkcl <lkcl@web>
Date: Sun, 24 Jul 2022 00:34:14 +0000 (+0100)
Subject: (no commit message)
X-Git-Tag: opf_rfc_ls005_v1~1058
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=c1b6014c9455ac03f3cb1fc2035ac11928d8d3d6;p=libreriscv.git

---

diff --git a/docs/pypowersim.mdwn b/docs/pypowersim.mdwn
index 18621ffcf..baf0fbaef 100644
--- a/docs/pypowersim.mdwn
+++ b/docs/pypowersim.mdwn
@@ -140,10 +140,10 @@ After execution 128 bytes are dumped from address 0x900000.
    9         -i audio/mp3/mp3_0_apply_window_float.bin
 ```
 
-# Before running the tests!
+# Before running the media tests
 
-As the SVP64 spec and Libre-SOC CPU is developing, the available opcodes
-will grow. Make sure to update the auto-generated Python functions
+During development, the available opcodes may change.
+Make sure to update the auto-generated Python functions
 simulating the instructions. Also the audio data needs to be downloaded.
 
 * run "pywriter". This is an installed utility, so should be in your PATH.
@@ -161,7 +161,9 @@ $ make wget
 
 Run the Makefile in the "openpower-isa/media" directory with "tests" arg:
 
-* run "make tests"
+```
+$ make tests
+```
 
 All the debug will go to standard output, so you may wish to direct it to a
 log file (the file will be **big**!).
@@ -173,21 +175,25 @@ Makefile or export it manually.
 
 Inside "openpower-isa/media" directory run:
 
-* ./audio/mp3/mp3_0.sh 0 out
+```
+$ ./audio/mp3/mp3_0.sh 0 out0
+```
 
-The "out" file will be created in the "media" directory. Change the name
+The "out0" file will be created in the "media" directory. Change the name
 if you don't want the second test to overwrite the results of the first. 
 
 # Checking results
 
 If you run both tests through the makefile, the shell script
 automatically compares the input "sample0" file with the
-generated "out" file.
+generated "out0" file.
 
 For manual checking, you need to know where the "out" file is, and then
 use the "cmp" program to compare byte by byte the sample and output
 files.
 
-* cmp out0 data/audio/mp3/mp3_0_data/samples0
+```
+$ cmp out0 data/audio/mp3/mp3_0_data/samples0
+```
 
-No output indicates the files are identical.
+As is usual for UNIX commands no output indicates the files are identical.