-
Notifications
You must be signed in to change notification settings - Fork 791
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
[ipgen,tpl,cmdgen] Remove earlgrey CMDGEN output from ipgen templates #24973
Conversation
Thanks @matutem. I agree with the intention of this PR, but it doesn't seem to be aligned with what happens when Unfortunately it's not as simple as adding |
PR Once that PR is merged, we can make the following change diff --git a/hw/Makefile b/hw/Makefile
index 238e348a7a..1a5c2bcc31 100644
--- a/hw/Makefile
+++ b/hw/Makefile
@@ -136,6 +136,7 @@ topgen_rust_pkg: topgen_rust
top: $(tops_gen) $(tops_reg)
$(tops_gen): %_gen:
${PRJ_DIR}/util/topgen.py -t $(top-hjson) -o ${PRJ_DIR}/hw/$*/ ${toolflags}
+ ${PRJ_DIR}/util/cmdgen.py -u hw/$*/**/*.md
$(tops_reg): %_reg:
mkdir -p ${REG_OUTPUT_DV_DIR}/$* either as a new commit at the beginning of this PR or in a separate PR. Then this PR should be ready. |
I will file an issue and a separate PR for adding cmdgen in the Makefile target for top. I think it deserves better documentation since otherwise check-generated would fail. It is weird we didn't catch it for so long: a quick grep suggests we always have the top earlgrey text between brackets, which would break for multi-top, and perhaps we never checked this for englishbreakfast? I'll loop you in for sure. |
Filed #24991. |
4b639c5
to
3c455eb
Compare
Force-pushed to rebase on |
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.
This LGTM, thanks for fixing this properly for future multi-top.
I verified the resulting generated md files are unchanged. This requires running make -C hw, followed by cmdgen.py for the affected generated files. Signed-off-by: Guillermo Maturana <[email protected]>
With this change, |
Since this change, running topgen or make now seems to delete the top_earlgrey documentation which is problematic. Is that an unintentional consequence? Are we supposed to run another make command to restore the documentation? |
With this change, you would have to run |
I verified the resulting generated md files are unchanged. This requires running make -C hw, followed by cmdgen.py for the affected generated files.