Skip to content
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

Merged
merged 1 commit into from
Sep 6, 2021

Conversation

rodrigomelo9
Copy link

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.

docs/cli.rst Outdated Show resolved Hide resolved
docs/cli.rst Outdated

.. note:: ``2008`` is the default.

.. note:: you will receive an ERROR if you specify a not supported revision
Copy link
Member

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.

Copy link
Author

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
Copy link
Member

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.

Copy link
Author

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.

@umarcor umarcor changed the title doc/cli: add notes and a warning about VUNIT_VHDL_STANDAR doc/cli: add notes and a warning about VUNIT_VHDL_STANDARD Sep 5, 2021
@rodrigomelo9
Copy link
Author

@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.

@umarcor umarcor merged commit 4343d31 into dbhi:doc-envvars Sep 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants