-
Notifications
You must be signed in to change notification settings - Fork 299
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
Added some missing flow variables and descriptions #2555
Added some missing flow variables and descriptions #2555
Conversation
Signed-off-by: Jeff Ng <[email protected]>
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.
Just to check: This documentation is autogenerated by scripts/generatedocs.py
Did you update variables.py and rerub scripts/generatedocs.py?
Thanks for the pointer. I'll update variables.yaml and the generate-variables-docs.py script. |
Updated variables.yaml and re-generated FlowVariables.md. It looks like FlowVariables.md wasn't updated in a while, since there are a bunch of new additions in the generated file. |
@jeffng-or @maliberty Autogenerating .md files under git source control is not great, but github does not have any dynamic rendering capabilities in .md files. So, pick a poison: keep generated docs in git, or you dont get .md docs displayed when browsing github and the user needs to consult some other source. |
Unrelated to this PR that is just regenerating: RTLMP_FLOW should be deleted from variables.yaml USE_FILL default in variables.yaml needs a look |
@maliberty @jeffng-or I am of two minds of too much complication in CI for obscure cases, but it would be possible to check that FlowVariables.md, if changed, is not different after scripts/generatedocs.py has been run: this would cause failure when a PR manually modiies the autogenerated section. |
I imagine something like "Check That ODB Files Are Generated" in OR could be used for the docs. @vvbandeira @luarss any thoughts? |
I don't see any change to variables.yaml in this PR |
@maliberty There is some initial CI (WIP) for |
Thanks for the reference! |
Sorry, committed to the wrong branch. Updated the PR. |
I don't see any update - did you push? |
Signed-off-by: Jeff Ng <[email protected]>
Signed-off-by: Jeff Ng <[email protected]>
@jeffng-or @maliberty Defaults can originate in ORFS or OpenROAD. If they originate in ORFS, the single - source of truth is variables.yaml However, if the default values originate in OpenROAD, there is no way to automatically update FlowVariables.md, nor ensure that variables.yaml is up to date. The choices I can think of are:
As for recommendation, I am inclined to leaving as-is and switching to 3 for those cases where it turns out that it matters to anyone. |
No description provided.