diff options
Diffstat (limited to 'guidelines')
| -rw-r--r-- | guidelines/Checklists | 16 | ||||
| -rw-r--r-- | guidelines/CodingStyle | 3 | ||||
| -rw-r--r-- | guidelines/GettingStarted | 2 |
3 files changed, 8 insertions, 13 deletions
diff --git a/guidelines/Checklists b/guidelines/Checklists index cc61c7876..75af12fa9 100644 --- a/guidelines/Checklists +++ b/guidelines/Checklists @@ -11,7 +11,7 @@ Things to do right away: Things to do after finalizing the cell interface: - Add support to kernel/satgen.h for the new cell type - - Add to manual/CHAPTER_CellLib.tex (or just add a fixme to the bottom) + - Add to docs/source/CHAPTER_CellLib.rst (or just add a fixme to the bottom) - Maybe add support to the Verilog backend for dumping such cells as expression @@ -29,11 +29,9 @@ Update the CHANGELOG file: Update and check documentation: cd ~yosys - make update-manual - make manual - - sanity check the figures in the appnotes and presentation + make docs + - sanity check the figures in docs/images - if there are any odd things -> investigate - - make cosmetic changes to the .tex files if necessary cd ~yosys vi README guidelines/* @@ -74,7 +72,7 @@ And if a version of the verific library is currently available: ../../yosys test_navre.ys -Finally run all tests with "make config-{clang,gcc,gcc-4.8}": +Finally run all tests with "make config-{clang,gcc}": cd ~yosys make clean @@ -108,13 +106,11 @@ Release: Updating the website: cd ~yosys - make manual make install - - update pdf files on the website - cd ~yosys-web - make update_cmd make update_show git commit -am update make push + + - Read the Docs updates handled by Jenkins on source change diff --git a/guidelines/CodingStyle b/guidelines/CodingStyle index d3d3a7134..ee1e1a2b6 100644 --- a/guidelines/CodingStyle +++ b/guidelines/CodingStyle @@ -25,8 +25,7 @@ Formatting of code C++ Language ------------- -Yosys is written in C++11. At the moment only constructs supported by -gcc 4.8 are allowed in Yosys code. This will change in future releases. +Yosys is written in C++11. In general Yosys uses "int" instead of "size_t". To avoid compiler warnings for implicit type casts, always use "GetSize(foobar)" instead diff --git a/guidelines/GettingStarted b/guidelines/GettingStarted index fcc84c153..d27b285fc 100644 --- a/guidelines/GettingStarted +++ b/guidelines/GettingStarted @@ -191,7 +191,7 @@ Example Code The following yosys commands are a good starting point if you are looking for examples of how to use the Yosys API: - manual/CHAPTER_Prog/stubnets.cc + docs/source/CHAPTER_Prog/stubnets.cc manual/PRESENTATION_Prog/my_cmd.cc |