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.

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

Expand list of files formatted by Verible #6031

Merged
merged 1 commit into from
Apr 15, 2021

Conversation

rkapuscik
Copy link
Contributor

This PR is split from #6027 to keep the formatting changes separate.

It expands the Verible formatter allow list with some files where the changes were reviewed and found compliant to the lowRISC style guide.

@rkapuscik
Copy link
Contributor Author

CC @GregAC, @imphil.

Copy link
Contributor

@msfschaffner msfschaffner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making progress on the formatter front, @rkapuscik!

These changes look fairly uncontroversial to me.

WDYT, @udinator @sriyerg regarding the DV code?

Comment on lines 35 to 36


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could the formatter get rid of these extra unnecessary newlines?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that would actually be a useful feature! @hzeller

also, quick question: can the formatter replace tabs and trim trailing whitespace?
we see that creeping into the code base all the time...

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IIRC, if there are more than two newlines, they are compacted to two (but still leaving the freedom to the developer to distringuish between one line and 'more space'). @rkapuscik can probably confirm.
(But we are also currently avoiding re-formatting too long lines into multiple lines, so could be that this feature might not be active at this point as it involves line-break handling).

TAB -> space and removing trailing newline is handled by the formtter, yes.

@@ -55,7 +55,7 @@ module adc_ctrl (
.reg2hw(reg2hw),
.hw2reg(hw2reg),
.intg_err_o(),
.devmode_i (1'b1)
.devmode_i(1'b1)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can the formatter align the brackets on these lines (51-58)?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like the formatter is sometimes aligning brackets, but not in this case. Antmicro is looking into it.

Copy link
Contributor Author

@rkapuscik rkapuscik Apr 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is controlled by --named_port_alignment option in Verible. By default it is set to infer (it was not explicitly set in the original formatter script), but if the consensus is to have named port connections aligned we can set it to align.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for checking that @rkapuscik. I opened lowRISC/style-guides#48 to get indication on which style we prefer, but for this PR the change is fine as-is: it keeps the existing style for this particular instantiation (which is non-tabbed), and just applies this rule consistently.

Copy link
Contributor

@sriyerg sriyerg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly LGTM. Left some questions and one comment on how the constraints were formatted (my personal pref, though I don't have strong feelings about it).

Copy link
Contributor

@imphil imphil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work, thanks! This PR will need one rebase to make the merge conflict go away and then we're ready to go!

I'll ask people to jump in on lowRISC/style-guides#48 to potentially find a project-wide consensus on the preferred formatting.

@imphil imphil merged commit 624ff14 into lowRISC:master Apr 15, 2021
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.

5 participants