aboutsummaryrefslogtreecommitdiffstats
path: root/CodingReadme
diff options
context:
space:
mode:
authorClifford Wolf <clifford@clifford.at>2015-02-09 16:36:37 +0100
committerClifford Wolf <clifford@clifford.at>2015-02-09 16:36:37 +0100
commit68979d13957825b2d9ec7638f5af057a3c832f89 (patch)
tree6caa17b2dfa675f26be7f12f44e481ef5c336e8f /CodingReadme
parenta779a09771f7373b8d1e77d7a9182fd3ed9008e5 (diff)
downloadyosys-68979d13957825b2d9ec7638f5af057a3c832f89.tar.gz
yosys-68979d13957825b2d9ec7638f5af057a3c832f89.tar.bz2
yosys-68979d13957825b2d9ec7638f5af057a3c832f89.zip
Various changes to release checklist
Diffstat (limited to 'CodingReadme')
-rw-r--r--CodingReadme70
1 files changed, 25 insertions, 45 deletions
diff --git a/CodingReadme b/CodingReadme
index f4924dfb2..1cee94e81 100644
--- a/CodingReadme
+++ b/CodingReadme
@@ -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+"
-
-