Structure suggestion

[numero-744]

Draft structure suggestion according to SpinalHDL/SpinalDoc-RTD#147

There are no unit / regression tests yet; I won't add anything for that before SpinalHDL/SpinalHDL#965 is merged and released (feedback welcome btw), or closed.

Don't merge before:

• Document scala file path SpinalDoc-RTD#147 has a consensus
• Mill configuration is updated and tested

[numero-744]

@Dolu1990 you started a review, so do I assume agreement on the structure?

So:

• can I start documenting it in Refactor step 1 SpinalDoc-RTD#150
• can I close Add Spinal config file #24

[Dolu1990]

One issue is the MyTopLevel folder :

• The package structure and the folder structure need to match. I already had issues with tools when it is done otherwise.

So it realy has to be removed
Which also kind of trash the xxx.scala structure you have. In someway, i think it need to be reverted back to something more similar to the original structure MyTopLevelGen.scala and so on

[numero-744]

Wilco for MyTopLevelGen.scala-like names with no MyTopLevel folder. It is a little bit less structured but that's not a big deal as it is compliant with lexical order so all is fine 👍

Other things to change? Can I start documenting?

[numero-744]

For MyTopLevelVerilog and MyTopLevelVhdl they are not in a MyTopLevelXxx file, isn't it an issue there too?

Maybe we should have this, which generates all by default, and depending on the synthesis tool used the users can remove the ones they don't need?

object MyTopLevelGen extends App {
  config.spinal.generateVerilog(MyTopLevel())
  config.spinal.generateVhdl(MyTopLevel())
}

[Dolu1990]

Other things to change? Can I start documenting?

So this and the other topics which were already opened, that's all ^^

For MyTopLevelVerilog and MyTopLevelVhdl they are not in a MyTopLevelXxx file, isn't it an issue there too?

Not an issue they can be both into MyTopLevelGen.scala

object MyTopLevelGen

Hmmm i think the best is to keep a Verilog and a Vhdl object instead of running two time the generation (which is something that normaly nobody do)

[numero-744]

Tested with mill running:

mill projectname.runMain projectname.MyTopLevelSim

[numero-744]

Rebased to clean history.

@Dolu1990 for merging

[numero-744]

@Dolu1990 I added two little commits as the PR is still open, but it can be merged I think

[Dolu1990]

Nice, thanks :)