diff options
author | 1138-4EB <1138-4EB@users.noreply.github.com> | 2017-02-19 05:42:34 +0100 |
---|---|---|
committer | tgingold <tgingold@users.noreply.github.com> | 2017-12-10 12:02:05 +0100 |
commit | 45dfdf3444abe623b4eab42cd1553c8e4b56f139 (patch) | |
tree | 8efeb2644e26fbf342747e96be8d019eb687e18d /doc/0_Intro | |
parent | b1e36c8668920054ab8570e5b0417479d36b834c (diff) | |
download | ghdl-45dfdf3444abe623b4eab42cd1553c8e4b56f139.tar.gz ghdl-45dfdf3444abe623b4eab42cd1553c8e4b56f139.tar.bz2 ghdl-45dfdf3444abe623b4eab42cd1553c8e4b56f139.zip |
Moving old content to new structure
Diffstat (limited to 'doc/0_Intro')
-rw-r--r-- | doc/0_Intro/.gitempty | 0 | ||||
-rw-r--r-- | doc/0_Intro/Contributing.rst | 71 | ||||
-rw-r--r-- | doc/0_Intro/Copyrights.rst | 55 | ||||
-rw-r--r-- | doc/0_Intro/WhatIsVHDL.rst | 4 |
4 files changed, 130 insertions, 0 deletions
diff --git a/doc/0_Intro/.gitempty b/doc/0_Intro/.gitempty deleted file mode 100644 index e69de29bb..000000000 --- a/doc/0_Intro/.gitempty +++ /dev/null diff --git a/doc/0_Intro/Contributing.rst b/doc/0_Intro/Contributing.rst index 7a9b4fe75..8a0ba30bc 100644 --- a/doc/0_Intro/Contributing.rst +++ b/doc/0_Intro/Contributing.rst @@ -3,4 +3,75 @@ Contributing ############ +Despite all the testing and already reported `issues <https://github.com/tgingold/ghdl/issues>`_, you can find bugs +or propose enhancements. + .. _reporting_bugs: + +Asking for enhancements +============== + +Reporting bugs +============== + +In order to improve GHDL, we welcome bugs report and suggestions for +any aspect of GHDL. Please create an issue on +https://github.com/tgingold/ghdl/issues + +If the compiler crashes, this is a bug. Reliable tools never crash. + +If your compiled VHDL executable crashes, this may be a bug at +runtime or the code produced may be wrong. However, since VHDL +has a notion of pointers, an erroneous VHDL program (using invalid +pointers for example) may crash. + +If the compiler emits an error message for a perfectly valid input or +does not emit an error message for an invalid input, this may be a bug. +Please send the input file and what you expected. If you know the LRM +well enough, please specify the paragraph which has not been well +implemented. If you don't know the LRM, maybe your bug report will be +rejected simply because there is no bug. In the latter case, it may be +difficult to discuss the issue; and comparisons with other VHDL tools +is not a very strong argument. + +If a compiler message is not clear enough for you, please tell me. The +error messages can be improved, but I have not enough experience with +them. + +If you send a `VHDL` file producing a bug, it is a good idea to try +to make it as short as possible. It is also a good idea to make it +looking like a test: write a comment which explains whether the file +should compile, and if yes, whether or not it should run successfully. +In the latter case, an assert statement should finish the test; the +severity level note indicates success, while a severity level failure +indicates failure. + +For bug reports, please include enough information for the maintainers to +reproduce the problem. This includes: + +* the version of `GHDL` (you can get it with :samp:`ghdl --version`). +* the operating system +* whether you have built `GHDL` from sources or used the binary + distribution. +* the content of the input files +* a description of the problem and samples of any erroneous input +* anything else that you think would be helpful. + +Documentation +============== + +If you have found a mistake in the manual, please send a comment. If +you have not understood some parts of this manual, please tell me. +English is not my mother tongue, so this manual may not be well-written. +Again, rewriting part of it is a good way to improve it. + +--- + +@TODO: + +- Reporting bugs + - [1138: Issues, search first] + - Minimum-(non)-Working-Example (MWE) +- Pull Requests (PRs) + - [1138: check chapter 2 -> building -> GHDL -> directory structure] + - [1138: beware that some commit messages can `automatically close <https://help.github.com/articles/closing-issues-via-commit-messages/>`_ PRs]
\ No newline at end of file diff --git a/doc/0_Intro/Copyrights.rst b/doc/0_Intro/Copyrights.rst new file mode 100644 index 000000000..1684fb035 --- /dev/null +++ b/doc/0_Intro/Copyrights.rst @@ -0,0 +1,55 @@ +.. _INTRO:Copyrights: + +Copyrights | License +############ + +The GHDL front-end, the :samp:`std.textio` package and the runtime +library (:samp:`grt`) are copyrighted Tristan Gingold, come with **absolutely +no warranty**, and are distributed under the conditions of the General +Public License. + +The :samp:`ieee.numeric_bit` and :samp:`ieee.numeric_std` packages are +copyrighted by the IEEE. The source files may be distributed without +change, except as permitted by the standard. + +This source file may not be +sold or distributed for profit. See the source file and the IEEE 1076.3 +standard for more information. + +The :samp:`ieee.std_logic_1164`, :samp:`ieee.Math_Real` and +:samp:`ieee.Math_Complex` packages are copyrighted by the IEEE. See +source files for more information. + +The :samp:`ieee.VITAL_Primitives`, :samp:`ieee.VITAL_Timing` and +:samp:`ieee.VITAL_Memory` packages are copyrighted by IEEE. See source +file and the IEEE 1076.4 standards for more information. + +The packages :samp:`std_logic_arith`, +:samp:`std_logic_signed`, :samp:`std_logic_unsigned` and +:samp:`std_logic_textio` contained in the :samp:`synopsys` directory are +copyrighted by Synopsys, Inc. The source files may be used and +distributed without restriction provided that the copyright statements +are not removed from the files and that any derivative work contains the +copyright notice. See the source files for more information. + +The package :samp:`std_logic_arith` contained in the :samp:`mentor` +directory is copyrighted by Mentor Graphics. The source files may be +distributed in whole without restriction provided that the copyright +statement is not removed from the file and that any derivative work +contains this copyright notice. See the source files for more information. + +As a consequence of the runtime copyright, you may not be allowed to +distribute an executable produced by `GHDL` without the VHDL +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: + +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 + +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 b78ddda9a..fbf0dbd73 100644 --- a/doc/0_Intro/WhatIsVHDL.rst +++ b/doc/0_Intro/WhatIsVHDL.rst @@ -27,3 +27,7 @@ instead of `execution`, with the same meaning. 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 |