search

YosysHQ / yosys

Yosys Open SYnthesis Suite
https://yosyshq.net/yosys/
ISC License
3.3k stars 860 forks source link

docs: Document $macc #4316

Closed widlarizer closed 2 months ago

widlarizer commented 3 months ago

I did my best to frontload the description with a bit that's free of CONFIG technicalities. This PR unfortunately duplicates information between cell library docs and simlib.v, where the first paragraph is pulled as the output of help $macc

widlarizer commented 3 months ago

Contributes to #121

KrystalDelusion commented 3 months ago

This PR unfortunately duplicates information between cell library docs and simlib.v, where the first paragraph is pulled as the output of help $macc

I'll bring this up at the docs JF, it might be worthwhile to dump the help output for all of the cells like we do with commands.

widlarizer commented 3 months ago

I pushed a fixup commit to the branch on my fork but it's not showing up in this PR :raised_eyebrow:

KrystalDelusion commented 3 months ago

LGTM

KrystalDelusion commented 2 months ago

FYI I am going to look into automatically including the verilog and comments from the simlib for each cell type into the docs, which will probably deprecate cell_library.rst but we can deal with that later.