You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+14-8Lines changed: 14 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -5,26 +5,22 @@ Hdlparse
5
5
6
6
Hdlparse is a simple package implementing a rudimentary parser for VHDL and Verilog. It is not capable of fully parsing the entire language. Rather, it is meant to extract enough key information from a source file to create generated documentation.
7
7
8
-
This library is used by the `Symbolator<https://github.com/kevinpt/symbolator>`_ diagram generator.
8
+
This library is forked from `kevinpt<https://github.com/kevinpt/hdlparse>`_ via `zhelnio <https://github.com/zhelnio/hdlparse>`_. The aim of this fork is to provide some bug fixes and additional features to zhelnio's version of Hdlparse. A list of changes is included at the bottom of this README.
9
9
10
10
For VHDL this library can extract component, subprogram, type, subtype, and constant declarations from a package. For Verilog it can extract module declarations (both 1995 and 2001 syntax).
11
11
12
12
13
13
Requirements
14
14
------------
15
15
16
-
Hdlparse requires either Python 2.7 or Python 3.x and no additional libraries.
17
-
18
-
The installation script depends on setuptools. The source is written in
19
-
Python 2.7 syntax but will convert cleanly to Python 3 when the installer
20
-
passes it through 2to3.
16
+
Hdlparse requires Python 3.x and no additional libraries. This version of Hdlparse is not compatible with Python2.
21
17
22
18
23
19
Download
24
20
--------
25
21
26
22
You can access the Hdlparse Git repository from `Github
27
-
<https://github.com/kevinpt/hdlparse>`_. You can install direct from PyPI with the "pip"
23
+
<https://github.com/vvvverre/hdlparse>`_. You can install direct from PyPI with the "pip"
28
24
command if you have it available.
29
25
30
26
Installation
@@ -55,7 +51,7 @@ You can also use ``pip`` to get the latest development code from Github:
If you manually downloaded a source package or created a clone with Git you can install with the following command run from the base Hdlparse directory:
61
57
@@ -74,3 +70,13 @@ Documentation
74
70
The full documentation is available online at the `main Hdlparse site
75
71
<http://kevinpt.github.io/hdlparse/>`_.
76
72
73
+
74
+
Changes
75
+
-------
76
+
77
+
A list of changes compared to the upstream is listed here:
78
+
79
+
* Improved support for VHDL and Verilog generics
80
+
* PEP8 compatible formatting
81
+
* Remove Python2 support
82
+
* Provide debugging information using the Python logging module
0 commit comments