Format chosen files using Verible formatter

[rkapuscik]

This PR introduces changes to Verible formatter script allowing it to format only a subset of OpenTitan files, along with a starting list of such files and relevant formatting fixes.

List of starting files was created by running Verible formatter on the project and adding ones that either needed no formatting or the changes were reviewed and found compliant to the lowRISC style guide. It is not complete in order to keep review manageable, but can be extended easily.

cc @GregAC, @imphil, @hzeller

[rswarbrick]

This looks like it might be a bit complicated to get merged, but most of the lint-fix changes look pretty uncontroversial to me. Maybe it would be worth splitting them into separate PRs? Then the "turn on the tool so I don't have to do things manually any more" PR ends up much smaller (and won't bit-rot quite as quickly).

[GregAC]

Thanks for this @rkapuscik

Given the simplicity of the formatting changes I'd hope we could do this in one or two PRs (one for format changes the other for the scripting).

I'd suggest squashing the commits down. Having all the formatting changes in a single commit is probably justifiable as they're all simple things and related in that they're all lint fixes to enable tooling. At least changes for related files should be squash together (no 'add changes', 'more changes' and 'final changes').

[rkapuscik]

Thank you for your input, I moved the formatting changes to #6031 (to be updated after this PR is resolved) and kept here only files that were not affected by the Verible formatter.

[tgorochowik]

@GregAC @imphil is this acceptable like this? Is there something we can do to proceed?

[imphil]

Thanks! I left some smallish comments, can you get those resolved and we can then merge it?

[imphil]

Suggested change

	FILES_TO_FORMAT=`cat util/verible-format-allowlist.vbl | sed '/^#/d'`
	FILES_TO_FORMAT=`grep -v '^#' util/verible-format-allowlist.vbl`

[rkapuscik]

That's cleaner, thank you. Changed.

[imphil]

Let's make this a file with a .txt suffix or so, .vbl is for Verible waiver/config files which are consumed by Verible directly

[rkapuscik]

Changed to .txt.

[imphil]

nit: no need for the ./

[rkapuscik]

Removed.

[imphil]

Suggested change

	xargs -n 1 -P $NUM_PROCS verible-verilog-format \
	xargs -n 1 -P $NUM_PROCS verible-verilog-format \

or align with the backslash above.

[rkapuscik]

Fixed.

[imphil]

LGTM, thanks! Would you mind combining the two commits into one, and then I'll merge it?

[rkapuscik]

No problem, I combined them.