diff options
| -rw-r--r-- | doc/0_Intro/Copyrights.rst | 12 | ||||
| -rw-r--r-- | doc/0_Intro/WhatIsVHDL.rst | 6 | ||||
| -rw-r--r-- | doc/2_Getting/Docker.rst | 25 | ||||
| -rw-r--r-- | doc/2_Getting/Releases.rst | 4 | ||||
| -rw-r--r-- | doc/3_Building/VendorPrimitives.rst | 11 | ||||
| -rw-r--r-- | doc/3_Building/index.rst | 36 | ||||
| -rw-r--r-- | doc/X_ChangeLog/Roadmap.rst (renamed from doc/X_ChangeLog/Roadmap.rst.txt) | 0 | ||||
| -rw-r--r-- | doc/X_ChangeLog/index.rst | 6 |
8 files changed, 91 insertions, 9 deletions
diff --git a/doc/0_Intro/Copyrights.rst b/doc/0_Intro/Copyrights.rst index 1684fb035..06cc7e4a9 100644 --- a/doc/0_Intro/Copyrights.rst +++ b/doc/0_Intro/Copyrights.rst @@ -44,12 +44,12 @@ sources. To my mind, this is not a real restriction, since there is no points in distributing VHDL executable. Please, send a comment (:ref:`Reporting_bugs`) if you don't like this policy. ---- +---------------- -@TODO: +.. TODO: topic -https://www.gnu.org/licenses/old-licenses/gpl-2.0.html + https://www.gnu.org/licenses/old-licenses/gpl-2.0.html + + Available in the following formats: plain text, Texinfo, LaTeX, standalone HTML, Docbook, Markdown, ODF, RT -Available in the following formats: plain text, Texinfo, LaTeX, standalone HTML, Docbook, Markdown, ODF, RT - -See `#280 <https://github.com/tgingold/ghdl/issues/280#issuecomment-279595802>`_
\ No newline at end of file + See `#280 <https://github.com/tgingold/ghdl/issues/280#issuecomment-279595802>`_
\ No newline at end of file diff --git a/doc/0_Intro/WhatIsVHDL.rst b/doc/0_Intro/WhatIsVHDL.rst index fbf0dbd73..b70b3a723 100644 --- a/doc/0_Intro/WhatIsVHDL.rst +++ b/doc/0_Intro/WhatIsVHDL.rst @@ -28,6 +28,8 @@ Like a program written in another hardware description language, a `VHDL` program can be transformed with a :dfn:`synthesis tool` into a netlist, that is, a detailed gate-level implementation. ---- +---------------- -@TODO: [1138: very very briefly explain that there are four major verions: 87, 93, 02 and 08]
\ No newline at end of file +.. TODO: topic + + @1138 very very briefly explain that there are four major verions: 87, 93, 02 and 08
\ No newline at end of file diff --git a/doc/2_Getting/Docker.rst b/doc/2_Getting/Docker.rst index db371222d..35a1c11b6 100644 --- a/doc/2_Getting/Docker.rst +++ b/doc/2_Getting/Docker.rst @@ -3,4 +3,29 @@ Docker containers ############# +What is docker? A primer +================= +Where are images hosted? +================= + +docker-hub +ghdl-tools +Dockerfiles + +Launch options +================= + +With(out) shared folder +---------------- + +Interactive/daemon +---------------- + +Shrinking +---------------- + +Additional tools, with(out) GUI +---------------- + +GtkWave, PoC, VUnit, OSVVM, UVVM
\ No newline at end of file diff --git a/doc/2_Getting/Releases.rst b/doc/2_Getting/Releases.rst index 9e06f65af..0fbd4542d 100644 --- a/doc/2_Getting/Releases.rst +++ b/doc/2_Getting/Releases.rst @@ -3,4 +3,6 @@ Releases ######## - +.. TODO: topic + + naming, stable, development, nightly
\ No newline at end of file diff --git a/doc/3_Building/VendorPrimitives.rst b/doc/3_Building/VendorPrimitives.rst index 098b382f3..49c35b5a4 100644 --- a/doc/3_Building/VendorPrimitives.rst +++ b/doc/3_Building/VendorPrimitives.rst @@ -315,3 +315,14 @@ $InstallationDirectory = @{ Author: Patrick Lehmann Last update: 28.10.2016 +------------------------ + +.. TODO: topic + + - Vendor Primitives + - Alters / Intel + - Lattice + - OSVVM + - UVVM + - Xilinx ISE + - Xilinx Vivado diff --git a/doc/3_Building/index.rst b/doc/3_Building/index.rst index 98468fd7f..d240ff94d 100644 --- a/doc/3_Building/index.rst +++ b/doc/3_Building/index.rst @@ -3,4 +3,40 @@ Building GHDL ############# +.. TODO: topic + `./BUILD.txt <https://github.com/tgingold/ghdl/blob/master/BUILD.txt>`_ + Directory structure of the main branch [1138: #279] + Coverage, `gcov`, is unique to gcc. That specific difference is not explained anywhere. Should be added. + @1138 Backtraces optional -patchable- + +GCC backend +================= + +- ./dist/gcc/INSTALL +- ./gcc/README +- Linux + +LLVM backend +================= + +- Linux +- Mac OS? +- Windows MinGW 32/64 + +Mcode backend +================= + +- ./dist/mcode/README +- Linux +- Windows GNAT GPL (32 only) +- Windows MinGW 32/64 + +Test suites +================= + +---------------- + +.. TODO: topic + + @1138 explain that there are two (maybe three with vhdl08 tests)
\ No newline at end of file diff --git a/doc/X_ChangeLog/Roadmap.rst.txt b/doc/X_ChangeLog/Roadmap.rst index 3577bc704..3577bc704 100644 --- a/doc/X_ChangeLog/Roadmap.rst.txt +++ b/doc/X_ChangeLog/Roadmap.rst diff --git a/doc/X_ChangeLog/index.rst b/doc/X_ChangeLog/index.rst index 385f7711a..959d68486 100644 --- a/doc/X_ChangeLog/index.rst +++ b/doc/X_ChangeLog/index.rst @@ -22,3 +22,9 @@ Change Log 2015/index 2016/index 2017/index + +------------------------ + +.. TODO: topic + + `./NEWS <https://github.com/tgingold/ghdl/blob/master/NEWS>`_ |