Merge pull request #32 from riscv/document_changes

Document changes

Author: neelgala

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 2.2.2 - 2020-06-09
+### Changed
+- Changed quickstart 'riscv_config' to 'riscv-config'
+- Changed checker.py to add check_reset_fill_fields() description
+
 ## 2.2.1 - 2020-05-18
 ### Changed
 - Changed minimum python version requirement to 3.6.0 which is typically easy to install on all

docs/source/quickstart.rst

@@ -151,7 +151,7 @@ Usage Example
 
 .. code-block:: bash
 
-    $ riscv_config -ispec examples/rv32i_isa.yaml -pspec examples/rv32i_platform.yaml
+    $ riscv-config -ispec examples/rv32i_isa.yaml -pspec examples/rv32i_platform.yaml
 
 Executing the above command should display the following on the terminal:
 

riscv_config/__init__.py

@@ -1,3 +1,3 @@
 from pkgutil import extend_path
 __path__ = extend_path(__path__, __name__)
-__version__ = "2.2.1"
+__version__ = "2.2.2"

riscv_config/checker.py

@@ -388,8 +388,10 @@ def get_fields(node, bitwidth):
 
 
 def check_reset_fill_fields(spec):
+    '''The check_reset_fill_fields function fills the field node with the names of the sub-fields of the register and then checks whether the reset-value of the register is a legal value. To do so, it iterates over all the subfields and extracts the corresponding field value from the reset-value. Then it checks the legality of the value according to the given field description. If the fields is implemented i.e accessible in both 64 bit and 32 bit modes, the 64 bit mode is given preference. '''
     errors = {}
     for node in spec:
+       
         if isinstance(spec[node], dict):
             if spec[node]['rv32']['accessible']:
                 spec[node]['rv32']['fields'] = get_fields(