Skip to content

Issue#1504: Added rules to restrict library and package names.#1506

Merged
jeremiah-c-leary merged 15 commits intojeremiah-c-leary:masterfrom
JHertz5:issue-1504
Sep 4, 2025
Merged

Issue#1504: Added rules to restrict library and package names.#1506
jeremiah-c-leary merged 15 commits intojeremiah-c-leary:masterfrom
JHertz5:issue-1504

Conversation

@JHertz5
Copy link
Copy Markdown
Collaborator

@JHertz5 JHertz5 commented Sep 1, 2025

Resolves #1504.
Note that this PR is dependent on #1487 and shouldn't be merged until that branch is merged.

@JHertz5 JHertz5 mentioned this pull request Sep 1, 2025
@jeremiah-c-leary
Copy link
Copy Markdown
Owner

Evening @JHertz5 ,

I added some documentation to cover the configuration of the new rules. Let me know what you think.

Thanks,

--Jeremy

@JHertz5
Copy link
Copy Markdown
Collaborator Author

JHertz5 commented Sep 4, 2025

Hi @jeremiah-c-leary

Thanks very much! That's a good idea, I hadn't considered adding that documentation page. I've made a couple of tweaks:

  • I've updated use_clause_001 to be disabled by default. This means that it now matches the new documentation page (which says "these rules are disabled by default"), and means that the two rules are more consistent with one another.
  • I've made a slight correction - The page used to say "All examples below are using the rule port_map_004.", which is presumably a copy/paste error. I've changed this to say use_clause_001 instead.
  • The second code example stated that the following code would fail three times with names set to ["work", "my_package"]
   library work;
     use work.my_package.all;

I think that library_012 would only fail once, on the first line, and I think that use_clause_012 would fail once on the second line. library_012 doesn't check use statements, only library statements. I've change the second example to one that I think is more accurate.

If you'd like me to add functionality to check the library calls in use statements, I could raise a new issue and add that quite easily.

I've pushed those changes, it should be ready for you to take a look at when you have a chance. Thanks again for the help!

@jeremiah-c-leary
Copy link
Copy Markdown
Owner

Morning @JHertz5 ,

Thanks for the updates to the documentation.

If you'd like me to add functionality to check the library calls in use statements, I could raise a new issue and add that quite easily.

I think since the library clause is required before a use clause that we do not need to check the library in the use clause.

Thanks again for the PR. I will get this merged to master.

--Jeremy

@jeremiah-c-leary jeremiah-c-leary merged commit d87a3b1 into jeremiah-c-leary:master Sep 4, 2025
12 checks passed
@JHertz5 JHertz5 deleted the issue-1504 branch September 11, 2025 17:51
@JHertz5 JHertz5 self-assigned this Sep 14, 2025
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.

Add library check

2 participants