Generate JSON instead of YAML

.github/workflows/python-app.yml

@@ -15,9 +15,8 @@ jobs:
       uses: actions/setup-python@v2
       with:
         python-version: 3.8
-    - name: Install PyYAML
+    - name: Install Coverage
       run: |
-        pip3 install -r requirements.txt
         pip3 install coverage
     - name: Run pre-commit
       run: |

.github/workflows/tests.yml

@@ -15,9 +15,8 @@ jobs:
       uses: actions/setup-python@v2
       with:
         python-version: 3.8
-    - name: Install PyYAML
+    - name: Install Coverage
       run: |
-         pip3 install -r requirements.txt
          pip3 install coverage
     - name: Test error outputs
       run: coverage run -m unittest -b

.gitignore

@@ -8,6 +8,6 @@ priv-instr-table.tex
 inst.rs
 inst.spinalhdl
 inst.sverilog
-instr_dict.yaml
+instr_dict.json
 
 __pycache__/

.pre-commit-config.yaml

@@ -26,13 +26,9 @@ repos:
   #   rev: v3.3.1
   #   hooks:
   #     - id: pylint
-  #       additional_dependencies:
-  #         - "pyyaml==6.0.2"
 
   # TODO: Enable this when types are added.
   # - repo: https://github.com/RobertCraigie/pyright-python
   #   rev: v1.1.383
   #   hooks:
   #     - id: pyright
-  #       additional_dependencies:
-  #         - "pyyaml==6.0.2"

README.md

@@ -126,9 +126,11 @@ of extensions are being processed such that the *base-instruction* is not includ
 
 The following artifacts can be generated using parse.py:
 
-- instr\_dict.yaml : This is file generated always by parse.py and contains the
-  entire main dictionary `instr\_dict` in YAML format. Note, in this yaml the
-  *dots* in an instruction are replaced with *underscores*
+- instr\_dict.json : This is always generated by parse.py and contains the
+  entire main dictionary `instr\_dict` in JSON format. Note, in this file the
+  *dots* in an instruction are replaced with *underscores*. In previous
+  versions of this project the generated file was instr\_dict.yaml. Note that
+  JSON is a subset of YAML so the file can still be read by any YAML parser.
 - encoding.out.h : this is the header file that is used by tools like spike, pk, etc
 - instr-table.tex : the latex table of instructions used in the riscv-unpriv spec
 - priv-instr-table.tex : the latex table of instruction used in the riscv-priv spec
@@ -138,14 +140,6 @@ The following artifacts can be generated using parse.py:
 - inst.spinalhdl : spinalhdl code to decode instructions
 - inst.go : go code to decode instructions
 
-Make sure you install the required python pre-requisites are installed by executing the following
-command:
-
-```
-sudo apt-get install python-pip3
-pip3 install -r requirements.txt
-```
-
 To generate all the above artifacts for all instructions currently checked in, simply run `make` from the root-directory. This should print the following log on the command-line:
 
 ```
@@ -220,6 +214,6 @@ DEBUG::      Processing line: bne     bimm12hi rs1 rs2 bimm12lo 14..12=1 6..2=0x
 ## How do I find where an instruction is defined?
 
 You can use `grep "^\s*<instr-name>" rv* unratified/rv*` OR run `make` and open
-`instr_dict.yaml` and search of the instruction you are looking for. Within that
-instruction the `extension` field will indicate which file the instruction was
-picked from.
+`instr_dict.json` and search for the instruction you are looking for. Within
+that instruction the `extension` field will indicate which file the
+instruction was picked from.

latex_utils.py

@@ -7,8 +7,6 @@
 import re
 import sys
 
-import yaml
-
 from constants import *
 from shared_utils import *
 

parse.py

@@ -1,11 +1,10 @@
 #!/usr/bin/env python3
 import collections
+import json
 import logging
 import pprint
 import sys
 
-import yaml
-
 from c_utils import *
 from chisel_utils import *
 from constants import *
@@ -44,8 +43,8 @@
 
     instr_dict = create_inst_dict(extensions, include_pseudo)
 
-    with open("instr_dict.yaml", "w") as outfile:
-        yaml.dump(add_segmented_vls_insn(instr_dict), outfile, default_flow_style=False)
+    with open("instr_dict.json", "w") as outfile:
+        json.dump(add_segmented_vls_insn(instr_dict), outfile, indent=2)
     instr_dict = collections.OrderedDict(sorted(instr_dict.items()))
 
     if "-c" in sys.argv[1:]: