How to file a PR for a bug fix?

Utility Library
,
1

We have integrated UVVM tag 2024.10.08 into one of our projects and we recently found a bug that is still present on the current master branch. The fix is relatively simple (a one-liner) so I want to file a PR.

Of course, I also want to update the uvvm_util testbench that does not currently cover the case to protect against regressions. However, I noticed that uvvm_util/tb/maintenance_tb has been moved from the UVVM/UVVM repo to the UVVM/UVVM_SUPPLEMENTARY repo.

To be honest, I do not understand what the UVVM_SUPPLEMENTARY repo is for. The git log of the commit where the maintenance testbench has been moved only refers to CHANGES.TXT where v2024.07.03b is not even mentioned. The Github repo description is identical to UVVM/UVVM’s description.

So my question is: What is your preferred way to file a PR that fixes a bug in the uvvm_util library and also expands the maintenance_tb?

Also, how the the maintenance_tb currently executed so I can verify my PR? I am on Windows using GHDL.

And at last: Why is 2d25e07 (the commit referenced by the 2024.10.08 tag) not part of any branch and does not seem to include the changes introduced in “v2024.07.03b” (removal of the maintance_tb)? Weirdly, 2024.10.08 seems to be behind 2024.07.03b.

PS: Your 2 links per post limit makes it hard to write a post with good references.

2

The reason for the UVVM supplementary repo was to have all the binary files and internal testbenches which increased the size of the main repo. However, since the documentation has now been moved to RST/HTML format, this is no longer necessary and the UVVM supplementary will be deprecated and the extra maintentance_tb files will be moved back to the main repo.

So to answer your question, you can make a PR with the fix in the main UVVM repo and include the new test as a comment so that we can add it to the testbench. We will add the testbench files to the main repo in the next release.

As for the second question, the maintenance_tb is executed using the maintenance_script/test.py script, which is run with HDLRegression. You can run it on Windows with GHDL.

The commit referenced by that tag seems to point to a different internal branch which is used during the release, which was done by mistake. If you look at the latest tags they should point to a commit in the correct branch.

The limit of the links was a default setting, it has now been increased.

3

Hi Erick,

thank you for the clarifications. I have create the PR and also attached a patch for the testbench.