update version and some docs

SystemRDL · Mar 12, 2023 · c7b7352 · c7b7352
1 parent d7c4b88
commit c7b7352
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 1 deletion.
diff --git a/docs/configuring.rst b/docs/configuring.rst
@@ -0,0 +1,22 @@
+Configuring PeakRDL-regblock
+============================
+
+If using the `PeakRDL command line tool <https://peakrdl.readthedocs.io/>`_,
+some aspects of the ``regblock`` command have additional configuration options
+avaiable via the PeakRDL TOML file.
+
+All regblock-specific options are defined under the ``[regblock]`` TOML heading.
+
+.. data:: cpuifs
+
+    Mapping of additional CPU Interface implementation classes to load.
+    The mapping's key indicates the cpuif's name.
+    The value is a string that describes the import path and cpuif class to
+    load.
+
+    For example:
+
+    .. code-block:: toml
+
+        [regblock]
+        cpuifs.my-cpuif-name = "my_cpuif_module:MyCPUInterfaceClass"
diff --git a/docs/index.rst b/docs/index.rst
@@ -100,6 +100,7 @@ Links
     architecture
     hwif
     api
+    configuring
     limitations
     licensing
 

diff --git a/src/peakrdl_regblock/__about__.py b/src/peakrdl_regblock/__about__.py
@@ -1 +1 @@
-__version__ = "0.10.0"
+__version__ = "0.11.0"