1 Checklist for adding internal cell types
2 ========================================
4 Things to do right away:
6 - Add to kernel/celltypes.h (incl. eval() handling for non-mem cells)
7 - Add to InternalCellChecker::check() in kernel/rtlil.cc
8 - Add to techlibs/common/simlib.v
9 - Add to techlibs/common/techmap.v
11 Things to do after finalizing the cell interface:
13 - Add support to kernel/satgen.h for the new cell type
14 - Add to manual/CHAPTER_CellLib.tex (or just add a fixme to the bottom)
15 - Maybe add support to the Verilog backend for dumping such cells as expression
19 Checklist for creating Yosys releases
20 =====================================
22 Update the CHANGELOG file:
29 Update and check documentation:
34 - sanity check the figures in the appnotes and presentation
35 - if there are any odd things -> investigate
36 - make cosmetic changes to the .tex files if necessary
39 vi README guidelines/*
40 - is the information provided in those file still up to date
43 Then with default config setting:
49 ./yosys -p 'proc; show' tests/simple/fiedler-cooley.v
50 ./yosys -p 'proc; opt; show' tests/simple/fiedler-cooley.v
51 ./yosys -p 'synth; show' tests/simple/fiedler-cooley.v
52 ./yosys -p 'synth_xilinx -top up3down5; show' tests/simple/fiedler-cooley.v
54 cd ~yosys/examples/cmos
57 cd ~yosys/examples/basys3
61 Test building plugins with various of the standard passes:
63 yosys-config --build test.so equiv_simple.cc
64 - also check the code examples in guidelines/GettingStarted
67 And if a version of the verific library is currently available:
70 cat frontends/verific/build_amd64.txt
74 ../../yosys test_navre.ys
77 Finally run all tests with "make config-{clang,gcc,gcc-4.8}":
91 make purge gen_issues gen_samples
92 make SYN_LIST="yosys" SIM_LIST="icarus yosim verilator" REPORT_FULL=1 world
93 chromium-browser report.html
98 - set YOSYS_VER to x.y.z in Makefile
99 - remove "bumpversion" target from Makefile
100 - update version string in CHANGELOG
101 git commit -am "Yosys x.y.z"
104 - post changelog on github
105 - post short release note on reddit
108 Updating the website:
114 - update pdf files on the website
119 git commit -am update