From c7b73527469c5c3880dbcece80f504c5c4cf6841 Mon Sep 17 00:00:00 2001 From: Alex Mykyta Date: Sat, 11 Mar 2023 22:11:46 -0800 Subject: [PATCH] update version and some docs --- docs/configuring.rst | 22 ++++++++++++++++++++++ docs/index.rst | 1 + src/peakrdl_regblock/__about__.py | 2 +- 3 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 docs/configuring.rst diff --git a/docs/configuring.rst b/docs/configuring.rst new file mode 100644 index 0000000..56b4287 --- /dev/null +++ b/docs/configuring.rst @@ -0,0 +1,22 @@ +Configuring PeakRDL-regblock +============================ + +If using the `PeakRDL command line tool `_, +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 index a72fb80..11ccfdf 100644 --- 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 index 61fb31c..ae6db5f 100644 --- a/src/peakrdl_regblock/__about__.py +++ b/src/peakrdl_regblock/__about__.py @@ -1 +1 @@ -__version__ = "0.10.0" +__version__ = "0.11.0"