Documentation and minor plugin changes.

[azidar]

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 state the API impact?
• N/A Did you specify the code generation impact?
• Did you request a desired merge strategy?
• Did you add text to be included in the Release Notes for this change?

Type of Improvement

• bug fix
• documentation
• code refactoring

API Impact

Moves the plugin API to a separate package, rather than being in experimental. Should only affect the release candidate, but since its a new API there is no backwards compatibility issues.

Desired Merge Strategy

• Squash: The PR will be squashed and merged (choose this if you have no preference.

Release Notes

Added documentation for the new Chisel naming plugin, viewable on our website!

Reviewer Checklist (only modified by reviewer)

• Did you add the appropriate labels?
• Did you mark the proper milestone (3.2.x, 3.3.x, 3.4.0, 3.5.0) ?
• Did you review?
• Did you check whether all relevant Contributor checkboxes have been checked?
• Did you mark as Please Merge?

[jackkoenig]

Some thoughts and suggestions. Some comments are more musings than actual suggestions.

[mwachs5]

drive by comment :) 👍

[jackkoenig]

Note that noPrefix only strips the 1 level of prefix, it doesn't remove all prefixes

[azidar]

I'm not sure that's true? I think it clears all prefixes?

[jackkoenig]

I don't think it does:

def buzz(arg: UInt) = {
  val x = c + arg
  b + x
}

def fizz(arg: UInt) = {
  val y = buzz(arg)
  a + y
}

import chisel3.experimental.prefix
import chisel3.experimental.noPrefix

val foo = prefix("jack")(fizz(3.U))
val bar = noPrefix(fizz(128.U))

out := foo + bar

gives

wire [7:0] foo_jack_y_x = c + 8'h3;
wire [7:0] foo_jack_y = b + foo_jack_y_x;
wire [7:0] foo = a + foo_jack_y;
wire [7:0] y_x = c + 8'h80;
wire [7:0] y = b + y_x;
wire [7:0] bar = a + y;
assign out = foo + bar;