Add typo and step # fixes
Small typo and step # fix, seems the hyperlink behaviour is inconsistent
if any special characters are in the header. Will keep the initial
bulletlist as an overview, but only some work as in page links (not as
critical since steps are numbered anyway).
Change-Id: Iff6fc52428d5219339235463e0f0ca4aa2287adb
diff --git a/CreateSpringbokVectorUnitTest.md b/CreateSpringbokVectorUnitTest.md
index e3fe647..6aeb8ba 100644
--- a/CreateSpringbokVectorUnitTest.md
+++ b/CreateSpringbokVectorUnitTest.md
@@ -1,19 +1,19 @@
# Create Springbok Vector Unit Test
-* [Step 0: Repo Sync and Build Prequisties](#step-0:-repo-sync-and-build-prequisties)
-* [Step 1: Select Instruction and Update Tracker](#step-1:-select-instruction-and-update-tracker)
-* [Step 2: Create operation definition in `${ROOTDIR}/sw/vec/softrvv/include`](#step-2:-create-operation-definition-in-`${rootdir}/sw/vec/softrvv/include`)
-* [Step 4: Add the header to `softrvv.h`](#step-4:-add-the-header-to-`softrvv.h`)
-* [Step 5: Add main test entry within the CMakeLists.txt](#step-5:-add-main-test-entry-within-the-cmakelists.txt)
-* [Step 6: Create subtest](#step-6:-create-subtest)
+* [Step 0: Repo Sync and Build Prequisites](#step-0_-repo-sync-and-build-prequisites)
+* [Step 1: Select Instruction and Update Tracker](#step-1_select-instruction-and-update-tracker)
+* [Step 2: Create operation definition in `${ROOTDIR}/sw/vec/softrvv/include`](#step-2_create-operation-definition-in)
+* [Step 3: Add the header to softrvv.h](#step-3_-add-the-header-to-softrvv_h)
+* [Step 4: Add main test entry within the CMakeLists.txt](#step-4_-add-main-test-entry-within-the-cmakelists_txt)
+* [Step 5: Create subtest](#step-5_-create-subtest)
* [Add brief softrvv test](#add-brief-softrvv-test)
* [Add this smaller test to a 2nd Cmake file](#add-this-smaller-test-to-a-2nd-cmake-file)
-* [Step 7: Build and Run Tests](#step-7:-build-and-run-tests)
-* [Step 8 (optional): view generated code](#step-8-(optional):-view-generated-code)
-* [Step 9: Mark Tests as Passing](#step-9:-mark-tests-as-passing)
-* [Step 10: Git Commit](#step-10:-git-commit)
+* [Step 6: Build and Run Tests](#step-6_-build-and-run-tests)
+* [Step 7 (optional): view generated code](#step-7-optional_view-generated-code)
+* [Step 8: Mark Tests as Passing](#step-8_-mark-tests-as-passing)
+* [Step 9: Git Commit](#step-9_-git-commit)
-## Step 0: Repo Sync and Build Prequisties
+## Step 0: Repo Sync and Build Prequisites
```sh
repo sync
@@ -55,7 +55,7 @@
See [softrvv_vadd.h](https://spacebeaker.googlesource.com/shodan/sw/vec/+/refs/heads/master/softrvv/include/softrvv_vadd.h) for a reference.
-## Step 4: Add the header to `softrvv.h`
+## Step 3: Add the header to softrvv.h
Add the header file as an includes in the `softrvv.h`:
@@ -67,7 +67,7 @@
-## Step 5: Add main test entry within the CMakeLists.txt
+## Step 4: Add main test entry within the CMakeLists.txt
`cd` into the following folder, and edit the `CMakeLists.txt` file there
@@ -99,7 +99,7 @@
Note on `__itcm_length__`: keeping this number low for each test helps our overall performance, most tests are good with 128K, some might need a little more memory (`ctest` will let you know if you need to add more here).
-## Step 6: Create subtest
+## Step 5: Create subtest
Please also add a small manual test the new softvv instruction.
Steps delineated as follows:
@@ -152,7 +152,7 @@
-Xlinker --defsym=__itcm_length__=128K
```
-## Step 7: Build and Run Tests
+## Step 6: Build and Run Tests
Tests must be run from the `${ROOTDIR}/out/springbok` directory.
@@ -165,7 +165,7 @@
m springbok && ctest --verbose -R ".*vadd.*" --gtest_color=yes
```
-## Step 8 (optional): view generated code
+## Step 7 (optional): view generated code
Code for the main test was autogenerated, however by `cd`'ing into the following directory, one can inspect the generated code.
@@ -173,7 +173,7 @@
${ROOTDIR}/out/springbok/tests/generated/
```
-## Step 9: Mark Tests as Passing
+## Step 8: Mark Tests as Passing
Note: at minimum, one's test should be expected to pass in Qemu. Since Renode vec support is WIP, a unit test failing may indicate problem in the Renode implementation.
@@ -183,7 +183,7 @@
2. Mark whether the unit test passes in Renode
3. Mark the instruction "Springbok Unit Test" as "implemented"
-## Step 10: Git Commit
+## Step 9: Git Commit
At this point there are two commitable chunks:
