Merge pull request #44 from vermaete/master

A few changes
oddball · May 23, 2023 · d47034a · d47034a
2 parents 1823f04 + 2dd3bd9
commit d47034a
Show file tree

Hide file tree

Showing 20 changed files with 243 additions and 180 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -24,4 +24,5 @@ jobs:
       - run: make compile_ghdl
       - run: make compile_verilator
       - run: make test_c
+      - run: make test_rst
 
diff --git a/Makefile b/Makefile
@@ -87,6 +87,8 @@ clean:
 validate:
 	xmllint --noout --schema ipxact2systemverilog/xml/component.xsd  example/input/test.xml
 
+test_rst:
+	rst-lint example/output/*.rst
 
 venv: requirements.txt
 	python3 -m venv ./venv

diff --git a/README.md b/README.md
@@ -56,7 +56,7 @@ xmllint --noout --schema ipxact2systemverilog/xml/component.xsd  example/input/t
 ## Dependencies
 
 ```bash
-pip install docutils lxml tabulate mdutils
+pip install docutils lxml mdutils
 ```
 
 ## Dependencies used by makefile

diff --git a/bin/ipxact2c b/bin/ipxact2c
@@ -25,6 +25,7 @@ if __name__ == '__main__':
 
     config = configparser.ConfigParser()
     if args.config:
+        config.read_dict(DEFAULT_INI)
         config.read(args.config)
     else:
         config.read_dict(DEFAULT_INI)

diff --git a/bin/ipxact2md b/bin/ipxact2md
@@ -23,6 +23,7 @@ if __name__ == '__main__':
 
     config = configparser.ConfigParser()
     if args.config:
+        config.read_dict(DEFAULT_INI)
         config.read(args.config)
     else:
         config.read_dict(DEFAULT_INI)

diff --git a/bin/ipxact2rst b/bin/ipxact2rst
@@ -24,6 +24,7 @@ if __name__ == '__main__':
 
     config = configparser.ConfigParser()
     if args.config:
+        config.read_dict(DEFAULT_INI)
         config.read(args.config)
     else:
         config.read_dict(DEFAULT_INI)

diff --git a/bin/ipxact2systemverilog b/bin/ipxact2systemverilog
@@ -25,6 +25,7 @@ if __name__ == '__main__':
 
     config = configparser.ConfigParser()
     if args.config:
+        config.read_dict(DEFAULT_INI)
         config.read(args.config)
     else: 
         config.read_dict(DEFAULT_INI)

diff --git a/bin/ipxact2vhdl b/bin/ipxact2vhdl
@@ -25,6 +25,7 @@ if __name__ == '__main__':
 
     config = configparser.ConfigParser()
     if args.config:
+        config.read_dict(DEFAULT_INI)
         config.read(args.config)
     else:
         config.read_dict(DEFAULT_INI)

diff --git a/example/input/test.xml b/example/input/test.xml
@@ -12,6 +12,7 @@
       <spirit:name>unusedMemoryMapName</spirit:name>
       <spirit:addressBlock>
         <spirit:name>example</spirit:name>
+        <spirit:description>Demo example used for the testing of the ipxact2systemverilog tool.</spirit:description>
         <spirit:baseAddress>0</spirit:baseAddress>
         <spirit:range>6</spirit:range>
         <spirit:width>32</spirit:width>

diff --git a/example/output/example.docx b/example/output/example.docx
diff --git a/example/output/example.html b/example/output/example.html
@@ -2,9 +2,9 @@
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 <head>
 <meta charset="utf-8" />
+<meta name="generator" content="Docutils 0.20.1: https://docutils.sourceforge.io/" />
 <meta name="viewport" content="width=device-width, initial-scale=1" />
-<meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
-<title>Register description</title>
+<title>example</title>
 <style type="text/css">
 
 /* Minimal style sheet for the HTML output of Docutils.                    */
@@ -291,7 +291,7 @@
 /* Rules for easy reading and pre-defined style variants.                  */
 /*                                                                         */
 /* :Author: Günter Milde, based on html4css1.css by David Goodger          */
-/* :Id: $Id: plain.css 9081 2022-06-19 20:23:12Z milde $                                                               */
+/* :Id: $Id: plain.css 9338 2023-04-08 21:08:47Z milde $                                                               */
 /* :Copyright: © 2015 Günter Milde.                                        */
 /* :License: Released under the terms of the `2-Clause BSD license`_,      */
 /*    in short:                                                            */
@@ -570,7 +570,8 @@
   font-weight: bold;
 }
 mstyle.mathscr, mi.mathscr {
-  font-family: STIX;
+  font-family: STIX, XITSMathJax_Script, rsfs10,
+               "Asana Math", Garamond, cursive;
 }
 
 /* Epigraph           */
@@ -603,9 +604,15 @@
 </style>
 </head>
 <body>
-<main id="register-description">
-<h1 class="title">Register description</h1>
+<main id="example">
+<h1 class="title">example</h1>
 
+<p>Demo example used for the testing of the ipxact2systemverilog tool.</p>
+<dl class="field-list simple">
+<dt>Base Address<span class="colon">:</span></dt>
+<dd><p>0x0</p>
+</dd>
+</dl>
 <section id="registers">
 <h2>Registers</h2>
 <table>
@@ -894,7 +901,8 @@ <h2>reg4</h2>
 <dd><p>read-write</p>
 </dd>
 <dt>Description<span class="colon">:</span></dt>
-<dd><p>reg4 is a very useful register. It can take down the moon when configured correctly.</p>
+<dd><p>reg4 is a very useful register. It can take down the moon
+when configured correctly.</p>
 </dd>
 </dl>
 <table>
@@ -927,7 +935,8 @@ <h2>reg5</h2>
 <dd><p>read-write</p>
 </dd>
 <dt>Description<span class="colon">:</span></dt>
-<dd><p>reg5 is as useful as reg4 but without a reset value defined.</p>
+<dd><p>reg5 is as useful as reg4 but without a reset value
+defined.</p>
 </dd>
 </dl>
 <table>

diff --git a/example/output/example.md b/example/output/example.md
@@ -1,5 +1,11 @@
 
-# Register description
+# example
+
+
+Demo example used for the testing of the ipxact2systemverilog tool.
+
+Base Address: 0x0
+
 
 ## Registers
 

diff --git a/example/output/example.rst b/example/output/example.rst
@@ -1,6 +1,10 @@
-====================
-Register description
-====================
+=======
+example
+=======
+
+Demo example used for the testing of the ipxact2systemverilog tool.
+
+:Base Address: 0x0
 
 Registers
 ---------
@@ -30,10 +34,10 @@ Registers
 reg0
 ----
 
-:Name:        reg0
-:Address:     0x0
+:Name: reg0
+:Address: 0x0
 :Reset Value: 0x00000000
-:Access:      read-write
+:Access: read-write
 :Description: write something useful for reg0
 
 +---------+--------------+---------+-----------------------------------+
@@ -51,11 +55,11 @@ reg0
 reg1
 ----
 
-:Name:        reg1
-:Address:     0x1
+:Name: reg1
+:Address: 0x1
 :Reset Value: 0x00000001
-:Access:      read-write
-:Description: 
+:Access: read-write
+:Description:
 
 +--------+--------------+------------+-----------------------------------+
 | Bits   | Field name   | Reset      | Description                       |
@@ -66,10 +70,10 @@ reg1
 reg2
 ----
 
-:Name:        reg2
-:Address:     0x2
+:Name: reg2
+:Address: 0x2
 :Reset Value: 0x00000001
-:Access:      read-write
+:Access: read-write
 :Description: write something useful for reg2
 
 +--------+--------------+---------+-----------------------------------------+
@@ -85,7 +89,7 @@ reg2
 +--------+--------------+---------+-----------------------------------------+
 
 monkey
-,,,,,,
+~~~~~~
 
 +---------+---------+--------------------+
 | Name    | Value   | Description        |
@@ -98,7 +102,7 @@ monkey
 +---------+---------+--------------------+
 
 monkey2
-,,,,,,,
+~~~~~~~
 
 +---------+---------+---------------+
 | Name    | Value   | Description   |
@@ -113,10 +117,10 @@ monkey2
 reg3
 ----
 
-:Name:        reg3
-:Address:     0x3
+:Name: reg3
+:Address: 0x3
 :Reset Value: 0x00000001
-:Access:      read-write
+:Access: read-write
 :Description: write something useful for reg3
 
 +--------+--------------+------------+-----------------------------------+
@@ -128,11 +132,12 @@ reg3
 reg4
 ----
 
-:Name:        reg4
-:Address:     0x4
+:Name: reg4
+:Address: 0x4
 :Reset Value: 0x0000000c
-:Access:      read-write
-:Description: reg4 is a very useful register. It can take down the moon when configured correctly.
+:Access: read-write
+:Description: reg4 is a very useful register. It can take down the moon
+   when configured correctly.
 
 +--------+--------------+------------+---------------+
 | Bits   | Field name   | Reset      | Description   |
@@ -143,10 +148,11 @@ reg4
 reg5
 ----
 
-:Name:        reg5
-:Address:     0x5
-:Access:      read-write
-:Description: reg5 is as useful as reg4 but without a reset value defined.
+:Name: reg5
+:Address: 0x5
+:Access: read-write
+:Description: reg5 is as useful as reg4 but without a reset value
+   defined.
 
 +--------+--------------+---------------+
 | Bits   | Field name   | Description   |
@@ -157,9 +163,9 @@ reg5
 reg6
 ----
 
-:Name:        reg6
-:Address:     0x6
-:Access:      read-only
+:Name: reg6
+:Address: 0x6
+:Access: read-only
 :Description: reg6 is a read only register.
 
 +--------+--------------+---------------+
@@ -171,10 +177,10 @@ reg6
 reg7
 ----
 
-:Name:        reg7
-:Address:     0x7
+:Name: reg7
+:Address: 0x7
 :Reset Value: 0x00000000
-:Access:      read-write
+:Access: read-write
 :Description: write something useful for reg7
 
 +---------+--------------+---------+------------------------------------+
@@ -194,10 +200,10 @@ reg7
 reg8
 ----
 
-:Name:        reg8
-:Address:     0x8
+:Name: reg8
+:Address: 0x8
 :Reset Value: 0x00000000
-:Access:      read-write
+:Access: read-write
 :Description: register with empty and no descriptions of the fields
 
 +--------+--------------+---------+---------------+

diff --git a/example/output/example.rtf b/example/output/example.rtf
@@ -2,8 +2,11 @@
 {\colortbl;\red255\green0\blue0;\red0\green0\blue255;}
 \widowctrl\hyphauto
 
-{\pard \qc \f0 \sa180 \li0 \fi0 \b \fs36 Register description\par}
+{\pard \qc \f0 \sa180 \li0 \fi0 \b \fs36 example\par}
 {\pard \ql \f0 \sa180 \li0 \fi0 \par}
+{\pard \ql \f0 \sa180 \li0 \fi0 Demo example used for the testing of the ipxact2systemverilog tool.\par}
+{\pard \ql \f0 \sa0 \li0 \fi0 Base Address\par}
+{\pard \ql \f0 \sa180 \li360 \fi0 0x0\sa180\par}
 {\pard \ql \f0 \sa180 \li0 \fi0 \b \fs36 Registers\par}
 {
 \trowd \trgaph120

diff --git a/example/output_default/example.md b/example/output_default/example.md
@@ -1,5 +1,11 @@
 
-# Register description
+# example
+
+
+Demo example used for the testing of the ipxact2systemverilog tool.
+
+Base Address: 0x0
+
 
 ## Registers