search

chipsalliance / f4pga-v2x

Tool for converting specialized annotated Verilog models into XML needed for Verilog to Routing flow.
https://f4pga-v2x.readthedocs.io/en/latest/
Apache License 2.0
10 stars 12 forks source link

docs: Show all READMEs from the tests in the docs #71

Closed daniellimws closed 3 years ago

daniellimws commented 4 years ago

Changes:

Close #70

Signed-off-by: Daniel Lim Wee Soong weesoong.lim@gmail.com

daniellimws commented 4 years ago

Some problems I faced:

Undefined module OMUX

This line from pair.sim.v references an OMUX module

https://github.com/SymbiFlow/python-symbiflow-v2x/blob/21da32a7818df89a7815011d5ac38af476585a0a/tests/vtr/lutff-pair/pair.sim.v#L13

that is only generated and removed when running the tests as shown here

https://github.com/SymbiFlow/python-symbiflow-v2x/blob/21da32a7818df89a7815011d5ac38af476585a0a/tests/test_v2x.py#L57

This causes yosys to give an error when trying to generate a verilog-diagram for the PAIR module. Currently I avoided the error by not adding verilog-diagram to that section.

netlistsvg diagram too wide

image

Will need to modify the sphinxcontrib-verilog-diagram extension upstream code.

Code blocks have too many lines

Some of the model.xml files included have a few hundred lines, making the page very long. I don't think it would be good to truncate them as it will affect the completeness of this documentation. Might be good to extend the no-license extension to allow expanding/collapsing the code blocks, which can be done along with https://github.com/SymbiFlow/sphinxcontrib-verilog-diagrams/issues/36. Alternatively, we can only show a maximum number of lines and give a link to the actual file on Github.

Any ideas?

daniellimws commented 4 years ago

This should still be work in progress because of the problems above and the examples could have more explanation, but I'm not exactly sure what to add because of my limited knowledge of the project. Any suggestions would be helpful.

mithro commented 4 years ago

@mkurc, could you take over this can and get it merged?

mkurc commented 4 years ago

Wrong mkurc.

mithro commented 4 years ago

Opps, sorry! -- @mkurc-ant, could you take over this can and get it merged?

mkurc-ant commented 4 years ago

@mithro Ok, I'll take over this one.

mkurc-ant commented 3 years ago

Since I cannot push to daniellimws' repo I'm continuing this work in https://github.com/SymbiFlow/python-symbiflow-v2x/pull/78

mithro commented 3 years ago

Replaced by https://github.com/SymbiFlow/python-symbiflow-v2x/pull/78