Elide metadata by default, add --include-util-metadata

[jackkoenig]

The new metadata like SRAMDescription is useful, but there are some composition issues with various CIRCT transforms that are not yet resolved. Since this stuff is new (not yet released), I argue we should guard it under a CLI option (--include-util-metadata) for the time being. Ultimately, I expect we will want to include it by default, but I think we need the support to mature a bit first.

The only metadata at the moment is SRAMDescription, but we probably should do similar things with Queue and possibly other utils so I added a generic CLI option to guard them all.

We could also make it possible to elide metadata on an API call by API call basis. I thought about doing that for SRAM but due to the fact that default arguments cause binary compatibility issues, we keep increasing the number of apply methods for SRAM. It's currently 8, adding a new option would up that to 16. If we want to add it as an option for SRAM, I think we need to tweak how that API works, possibly putting some (or all) of the arguments into a class that we carefully maintain compatibility for.

Contributor Checklist

• Did you add Scaladoc to every public function/method?
• Did you add at least one test demonstrating the PR?
• Did you delete any extraneous printlns/debugging code?
• Did you specify the type of improvement?
• Did you add appropriate documentation in docs/src?
• Did you request a desired merge strategy?
• Did you add text to be included in the Release Notes for this change?

Type of Improvement

• API modification

Desired Merge Strategy

• Squash

Release Notes

Reviewer Checklist (only modified by reviewer)

• Did you add the appropriate labels? (Select the most appropriate one based on the "Type of Improvement")
• Did you mark the proper milestone (Bug fix: 3.6.x, 5.x, or 6.x depending on impact, API modification or big change: 7.0)?
• Did you review?
• Did you check whether all relevant Contributor checkboxes have been checked?
• Did you do one of the following when ready to merge:
  • Squash: You/ the contributor Enable auto-merge (squash), clean up the commit message, and label with Please Merge.
  • Merge: Ensure that contributor has cleaned up their commit history, then merge with Create a merge commit.

[mikeurbach]

The general approach makes sense to me. I can't say I'm familiar with Chisel CLI options, but giving a general stamp of approval.