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.

Sign up for GitHub

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

Jump to bottom

[ipgen] Insert per-ip DO NOT EDIT comment #25444

Open
matutem opened this issue Nov 28, 2024 · 1 comment
Open

[ipgen] Insert per-ip DO NOT EDIT comment #25444

matutem opened this issue Nov 28, 2024 · 1 comment
Assignees
@pamaury @matutem
Labels
Component:MultiTop Component:Tooling Issues related to tooling, e.g. tools/scripts for doc, code generation (docgen, reggen), CSR
Milestone
Tooling Improvements

Comments

@matutem
Copy link
Contributor

matutem commented Nov 28, 2024

Description

Pass specific per-IP gen_comment parameter to ipgen and insert it when expanding each .tpl file.
Files that are simply copied should also get this comment inserted after the copyright notice, or after any number of lines of consecutive comments starting with the first line.
Make a special case for .core files since they must start with CAPI=2 and their comments start with '#'.
@matutem matutem added Component:MultiTop Component:Tooling Issues related to tooling, e.g. tools/scripts for doc, code generation (docgen, reggen), CSR labels Nov 28, 2024
@matutem matutem added this to the Tooling Improvements milestone Nov 28, 2024
@pamaury
Copy link
Contributor

pamaury commented Nov 28, 2024

Sounds like a good idea, in the multitop_dev branch I already added a couple of comments for generated files but you are right that this should also apply to ipgen and non-templated files.

matutem added a commit to matutem/opentitan that referenced this issue Dec 13, 2024
@matutem
[ipgen,otp_ctrl] Remove gen_comment from templates
48ed336 
The comment regarding generation for ipgen artifacts will be dealt
with uniformly in the PR that fixes lowRISC#25444.
Remove gen_comment from the tpldesc file.

Part of lowRISC#25019

Signed-off-by: Guillermo Maturana <[email protected]>
a-will pushed a commit to matutem/opentitan that referenced this issue Dec 16, 2024
@matutem @a-will
[ipgen,otp_ctrl] Remove gen_comment from templates
287500d 
The comment regarding generation for ipgen artifacts will be dealt
with uniformly in the PR that fixes lowRISC#25444.
Remove gen_comment from the tpldesc file.

Part of lowRISC#25019

Signed-off-by: Guillermo Maturana <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pamaury pamaury

@matutem matutem

Labels
Component:MultiTop Component:Tooling Issues related to tooling, e.g. tools/scripts for doc, code generation (docgen, reggen), CSR
Projects
None yet
Milestone
Tooling Improvements
Development

No branches or pull requests
2 participants
@pamaury @matutem