Various changes to release checklist
authorClifford Wolf <clifford@clifford.at>
Mon, 9 Feb 2015 15:36:37 +0000 (16:36 +0100)
committerClifford Wolf <clifford@clifford.at>
Mon, 9 Feb 2015 15:36:37 +0000 (16:36 +0100)
CodingReadme
Makefile

index f4924dfb2db7018c69a4be77bc7ae3ab6d172d5a..1cee94e81d093e5ecf582a7a6c490bcceb2e3d9a 100644 (file)
@@ -282,30 +282,18 @@ Update the CHANGELOG file:
        vi CHANGELOG
 
 
-Update command reference in manual:
+Update and check documentation:
 
        cd ~yosys
-       make
-       cd manual
-       ../yosys -p 'help -write-tex-command-reference-manual'
-
-
-Run all tests with "make config-{clang,gcc,gcc-4.6}":
+       make update-manual
+       make manual
+       - sanity check the figures in the appnotes and presentation
+           - if there are any odd things -> investigate
+           - make cosmetic changes to the .tex files if necessary
 
        cd ~yosys
-       make clean
-       make test
-       make vloghtb
-       make install
-
-       cd ~yosys-bigsim
-       make clean
-       make full
-
-       cd ~vloghammer
-       make purge gen_issues gen_samples
-       make SYN_LIST="yosys" SIM_LIST="icarus yosim verilator" REPORT_FULL=1 world
-       chromium-browser report.html
+       vi README CodingReadme
+       - is the information provided in those file still up to date
 
 
 Then with default config setting:
@@ -319,15 +307,6 @@ Then with default config setting:
        ./yosys -p 'synth; show' tests/simple/fiedler-cooley.v
        ./yosys -p 'synth_xilinx -top up3down5; show' tests/simple/fiedler-cooley.v
 
-       cd ~yosys
-       make manual
-       - sanity check the figures in the appnotes and presentation
-           - if there are any odd things -> investigate
-           - make cosmetic changes to the .tex files if necessary
-
-
-Also with default config setting:
-
        cd ~yosys/techlibs/cmos
        bash testbench.sh
 
@@ -338,9 +317,10 @@ Also with default config setting:
 Test building plugins with various of the standard passes:
 
        yosys-config --build test.so equiv_simple.cc
+       - also check the code examples in CodingReadme
 
 
-Finally if a current verific library is available:
+And if a version of the verific library is currently available:
 
        cd ~yosys
        cat frontends/verific/build_amd64.txt
@@ -350,12 +330,22 @@ Finally if a current verific library is available:
        ../../yosys test_navre.ys
 
 
-Release candiate:
+Finally run all tests with "make config-{clang,gcc,gcc-4.6}":
+
+       cd ~yosys
+       make clean
+       make test
+       make vloghtb
+       make install
+
+       cd ~yosys-bigsim
+       make clean
+       make full
 
-       - create branch yosys-x.y.z-rc and push to github
-       - contact the usual suspects per mail and ask them to test
-       - post on the reddit and ask people to test
-       - commit KISS fixes to the -rc branch if necessary
+       cd ~vloghammer
+       make purge gen_issues gen_samples
+       make SYN_LIST="yosys" SIM_LIST="icarus yosim verilator" REPORT_FULL=1 world
+       chromium-browser report.html
 
 
 Release:
@@ -367,7 +357,6 @@ Release:
        - push tag to github
        - post changelog on github
        - post short release note on reddit
-       - delete -rc branch from github
 
 
 Updating the website:
@@ -384,12 +373,3 @@ Updating the website:
        git commit -am update
        make push
 
-
-In master branch:
-
-       git merge {release-tag}
-       - set version to x.y.z+ in Makefile
-       - add section "Yosys x.y.z .. x.y.z+" to CHANGELOG
-       git commit --amend -am "Yosys x.y.z+"
-
-
index b6cf42cb1699f9070aa0a12b387571d50c7b7b04..7b4707afefd341f3c6566c4ba3d89143542895ff 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -341,6 +341,9 @@ uninstall:
        $(INSTALL_SUDO) rm -vf $(addprefix $(DESTDIR)/bin/,$(notdir $(TARGETS)))
        $(INSTALL_SUDO) rm -rvf $(DESTDIR)/share/yosys/
 
+update-manual: $(TARGETS) $(EXTRA_TARGETS)
+       cd manual && ../yosys -p 'help -write-tex-command-reference-manual'
+
 manual: $(TARGETS) $(EXTRA_TARGETS)
        cd manual && bash appnotes.sh
        cd manual && bash presentation.sh