-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
doc/cli: add notes and a warning about VUNIT_VHDL_STANDARD #2
Conversation
docs/cli.rst
Outdated
|
||
.. note:: ``2008`` is the default. | ||
|
||
.. note:: you will receive an ERROR if you specify a not supported revision |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure this is required. In general, VUnit will report errors adequately when found. I mean, this is not specific to this feature, but a characteristic of the project.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok... Was annoying to receive an error when I tried a valid standard... Maybe clarify that the supported standard depends on the EDA tools used, and an ERROR is issued when not supported... I didn't found a section indicating which standards are supported by which tools. A link to this info would be enough...
docs/cli.rst
Outdated
(*"unknown"* when it is not supported by Vunit and *"invalid"* when | ||
it is not supported by a particular tool). | ||
|
||
.. warning:: the ``context`` statement is not supported previous 2008 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Similarly to the previous comment, I don't think this is particular to this section. That is one of the multiple differences introduced in VHDL 2008. The point is that the user guide and the examples are expected to be used with simulators having a "decent" VHDL 2008 support.
I do agree it would be interesting to have some comment about how some of the examples can be "easily" modified to work on specific simulators which support some VHDL 2008 but are lacking others. However, that belongs to section Examples.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
An explanation in the examples sounds good. So, a link here to such a section would be enough.
28a4b3a
to
4343d31
Compare
@umarcor I applied your suggestion and I merged the multiple notes/warnings in one smaller warning. Let me know if you directly want to remove it, but I think that is useful for people trying Vunit for the first time (my case). In the future, we can add a link here if a table about VHDL versions vs EDA tool, or the explanation about context, are added. |
Hi @umarcor I added some notes and warnings regarding VUNIT_VHDL_STANDAR. Maybe the note about context could be improved, but I think that a few lines are not enough.