aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
author1138-4EB <1138-4EB@users.noreply.github.com>2017-02-19 21:45:55 +0100
committertgingold <tgingold@users.noreply.github.com>2017-12-10 12:02:05 +0100
commit7423f48c2d85c8439181a4213ae65b2c1ed833af (patch)
tree6a2839d33f9a25987ca4cc2f912c82545d5679ed
parentf7eb81fad69185fc19ad8e3976252a2263040b60 (diff)
downloadghdl-7423f48c2d85c8439181a4213ae65b2c1ed833af.tar.gz
ghdl-7423f48c2d85c8439181a4213ae65b2c1ed833af.tar.bz2
ghdl-7423f48c2d85c8439181a4213ae65b2c1ed833af.zip
Allow markdown
Last files from oldmds removed. All the content is in the new structure now. COPYING replaced with the md version. Update NEWS.md
-rw-r--r--COPYING340
-rw-r--r--COPYING.md361
-rw-r--r--NEWS443
-rw-r--r--NEWS.md440
-rw-r--r--README.md6
-rw-r--r--doc/building/VendorPrimitives.md (renamed from doc/building/VendorPrimitives.rst)0
-rw-r--r--doc/building/index.rst156
-rw-r--r--doc/conf.py6
-rw-r--r--doc/index.rst14
-rw-r--r--doc/intro/Contributing.rst7
-rw-r--r--doc/intro/Copyrights.rst26
-rw-r--r--doc/oldmds/BUILD.txt140
-rw-r--r--doc/oldmds/gcc/INSTALL21
-rw-r--r--doc/oldmds/gcc/README51
-rw-r--r--doc/oldmds/mcode-README47
-rw-r--r--doc/references/CodingStyle.rst (renamed from doc/oldmds/STYLE)9
-rw-r--r--doc/references/CondigStyle.rst6
-rw-r--r--doc/using/InvokingGHDL.rst1
18 files changed, 998 insertions, 1076 deletions
diff --git a/COPYING b/COPYING
deleted file mode 100644
index d60c31a97..000000000
--- a/COPYING
+++ /dev/null
@@ -1,340 +0,0 @@
- GNU GENERAL PUBLIC LICENSE
- Version 2, June 1991
-
- Copyright (C) 1989, 1991 Free Software Foundation, Inc.
- 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
- Preamble
-
- The licenses for most software are designed to take away your
-freedom to share and change it. By contrast, the GNU General Public
-License is intended to guarantee your freedom to share and change free
-software--to make sure the software is free for all its users. This
-General Public License applies to most of the Free Software
-Foundation's software and to any other program whose authors commit to
-using it. (Some other Free Software Foundation software is covered by
-the GNU Library General Public License instead.) You can apply it to
-your programs, too.
-
- When we speak of free software, we are referring to freedom, not
-price. Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-this service if you wish), that you receive source code or can get it
-if you want it, that you can change the software or use pieces of it
-in new free programs; and that you know you can do these things.
-
- To protect your rights, we need to make restrictions that forbid
-anyone to deny you these rights or to ask you to surrender the rights.
-These restrictions translate to certain responsibilities for you if you
-distribute copies of the software, or if you modify it.
-
- For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must give the recipients all the rights that
-you have. You must make sure that they, too, receive or can get the
-source code. And you must show them these terms so they know their
-rights.
-
- We protect your rights with two steps: (1) copyright the software, and
-(2) offer you this license which gives you legal permission to copy,
-distribute and/or modify the software.
-
- Also, for each author's protection and ours, we want to make certain
-that everyone understands that there is no warranty for this free
-software. If the software is modified by someone else and passed on, we
-want its recipients to know that what they have is not the original, so
-that any problems introduced by others will not reflect on the original
-authors' reputations.
-
- Finally, any free program is threatened constantly by software
-patents. We wish to avoid the danger that redistributors of a free
-program will individually obtain patent licenses, in effect making the
-program proprietary. To prevent this, we have made it clear that any
-patent must be licensed for everyone's free use or not licensed at all.
-
- The precise terms and conditions for copying, distribution and
-modification follow.
-
- GNU GENERAL PUBLIC LICENSE
- TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
- 0. This License applies to any program or other work which contains
-a notice placed by the copyright holder saying it may be distributed
-under the terms of this General Public License. The "Program", below,
-refers to any such program or work, and a "work based on the Program"
-means either the Program or any derivative work under copyright law:
-that is to say, a work containing the Program or a portion of it,
-either verbatim or with modifications and/or translated into another
-language. (Hereinafter, translation is included without limitation in
-the term "modification".) Each licensee is addressed as "you".
-
-Activities other than copying, distribution and modification are not
-covered by this License; they are outside its scope. The act of
-running the Program is not restricted, and the output from the Program
-is covered only if its contents constitute a work based on the
-Program (independent of having been made by running the Program).
-Whether that is true depends on what the Program does.
-
- 1. You may copy and distribute verbatim copies of the Program's
-source code as you receive it, in any medium, provided that you
-conspicuously and appropriately publish on each copy an appropriate
-copyright notice and disclaimer of warranty; keep intact all the
-notices that refer to this License and to the absence of any warranty;
-and give any other recipients of the Program a copy of this License
-along with the Program.
-
-You may charge a fee for the physical act of transferring a copy, and
-you may at your option offer warranty protection in exchange for a fee.
-
- 2. You may modify your copy or copies of the Program or any portion
-of it, thus forming a work based on the Program, and copy and
-distribute such modifications or work under the terms of Section 1
-above, provided that you also meet all of these conditions:
-
- a) You must cause the modified files to carry prominent notices
- stating that you changed the files and the date of any change.
-
- b) You must cause any work that you distribute or publish, that in
- whole or in part contains or is derived from the Program or any
- part thereof, to be licensed as a whole at no charge to all third
- parties under the terms of this License.
-
- c) If the modified program normally reads commands interactively
- when run, you must cause it, when started running for such
- interactive use in the most ordinary way, to print or display an
- announcement including an appropriate copyright notice and a
- notice that there is no warranty (or else, saying that you provide
- a warranty) and that users may redistribute the program under
- these conditions, and telling the user how to view a copy of this
- License. (Exception: if the Program itself is interactive but
- does not normally print such an announcement, your work based on
- the Program is not required to print an announcement.)
-
-These requirements apply to the modified work as a whole. If
-identifiable sections of that work are not derived from the Program,
-and can be reasonably considered independent and separate works in
-themselves, then this License, and its terms, do not apply to those
-sections when you distribute them as separate works. But when you
-distribute the same sections as part of a whole which is a work based
-on the Program, the distribution of the whole must be on the terms of
-this License, whose permissions for other licensees extend to the
-entire whole, and thus to each and every part regardless of who wrote it.
-
-Thus, it is not the intent of this section to claim rights or contest
-your rights to work written entirely by you; rather, the intent is to
-exercise the right to control the distribution of derivative or
-collective works based on the Program.
-
-In addition, mere aggregation of another work not based on the Program
-with the Program (or with a work based on the Program) on a volume of
-a storage or distribution medium does not bring the other work under
-the scope of this License.
-
- 3. You may copy and distribute the Program (or a work based on it,
-under Section 2) in object code or executable form under the terms of
-Sections 1 and 2 above provided that you also do one of the following:
-
- a) Accompany it with the complete corresponding machine-readable
- source code, which must be distributed under the terms of Sections
- 1 and 2 above on a medium customarily used for software interchange; or,
-
- b) Accompany it with a written offer, valid for at least three
- years, to give any third party, for a charge no more than your
- cost of physically performing source distribution, a complete
- machine-readable copy of the corresponding source code, to be
- distributed under the terms of Sections 1 and 2 above on a medium
- customarily used for software interchange; or,
-
- c) Accompany it with the information you received as to the offer
- to distribute corresponding source code. (This alternative is
- allowed only for noncommercial distribution and only if you
- received the program in object code or executable form with such
- an offer, in accord with Subsection b above.)
-
-The source code for a work means the preferred form of the work for
-making modifications to it. For an executable work, complete source
-code means all the source code for all modules it contains, plus any
-associated interface definition files, plus the scripts used to
-control compilation and installation of the executable. However, as a
-special exception, the source code distributed need not include
-anything that is normally distributed (in either source or binary
-form) with the major components (compiler, kernel, and so on) of the
-operating system on which the executable runs, unless that component
-itself accompanies the executable.
-
-If distribution of executable or object code is made by offering
-access to copy from a designated place, then offering equivalent
-access to copy the source code from the same place counts as
-distribution of the source code, even though third parties are not
-compelled to copy the source along with the object code.
-
- 4. You may not copy, modify, sublicense, or distribute the Program
-except as expressly provided under this License. Any attempt
-otherwise to copy, modify, sublicense or distribute the Program is
-void, and will automatically terminate your rights under this License.
-However, parties who have received copies, or rights, from you under
-this License will not have their licenses terminated so long as such
-parties remain in full compliance.
-
- 5. You are not required to accept this License, since you have not
-signed it. However, nothing else grants you permission to modify or
-distribute the Program or its derivative works. These actions are
-prohibited by law if you do not accept this License. Therefore, by
-modifying or distributing the Program (or any work based on the
-Program), you indicate your acceptance of this License to do so, and
-all its terms and conditions for copying, distributing or modifying
-the Program or works based on it.
-
- 6. Each time you redistribute the Program (or any work based on the
-Program), the recipient automatically receives a license from the
-original licensor to copy, distribute or modify the Program subject to
-these terms and conditions. You may not impose any further
-restrictions on the recipients' exercise of the rights granted herein.
-You are not responsible for enforcing compliance by third parties to
-this License.
-
- 7. If, as a consequence of a court judgment or allegation of patent
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License. If you cannot
-distribute so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you
-may not distribute the Program at all. For example, if a patent
-license would not permit royalty-free redistribution of the Program by
-all those who receive copies directly or indirectly through you, then
-the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Program.
-
-If any portion of this section is held invalid or unenforceable under
-any particular circumstance, the balance of the section is intended to
-apply and the section as a whole is intended to apply in other
-circumstances.
-
-It is not the purpose of this section to induce you to infringe any
-patents or other property right claims or to contest validity of any
-such claims; this section has the sole purpose of protecting the
-integrity of the free software distribution system, which is
-implemented by public license practices. Many people have made
-generous contributions to the wide range of software distributed
-through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing
-to distribute software through any other system and a licensee cannot
-impose that choice.
-
-This section is intended to make thoroughly clear what is believed to
-be a consequence of the rest of this License.
-
- 8. If the distribution and/or use of the Program is restricted in
-certain countries either by patents or by copyrighted interfaces, the
-original copyright holder who places the Program under this License
-may add an explicit geographical distribution limitation excluding
-those countries, so that distribution is permitted only in or among
-countries not thus excluded. In such case, this License incorporates
-the limitation as if written in the body of this License.
-
- 9. The Free Software Foundation may publish revised and/or new versions
-of the General Public License from time to time. Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-Each version is given a distinguishing version number. If the Program
-specifies a version number of this License which applies to it and "any
-later version", you have the option of following the terms and conditions
-either of that version or of any later version published by the Free
-Software Foundation. If the Program does not specify a version number of
-this License, you may choose any version ever published by the Free Software
-Foundation.
-
- 10. If you wish to incorporate parts of the Program into other free
-programs whose distribution conditions are different, write to the author
-to ask for permission. For software which is copyrighted by the Free
-Software Foundation, write to the Free Software Foundation; we sometimes
-make exceptions for this. Our decision will be guided by the two goals
-of preserving the free status of all derivatives of our free software and
-of promoting the sharing and reuse of software generally.
-
- NO WARRANTY
-
- 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
-FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
-OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
-PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
-OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
-TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
-PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
-REPAIR OR CORRECTION.
-
- 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
-REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
-INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
-OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
-TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
-YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
-PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
-POSSIBILITY OF SUCH DAMAGES.
-
- END OF TERMS AND CONDITIONS
-
- How to Apply These Terms to Your New Programs
-
- If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
- To do so, attach the following notices to the program. It is safest
-to attach them to the start of each source file to most effectively
-convey the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
- <one line to give the program's name and a brief idea of what it does.>
- Copyright (C) <year> <name of author>
-
- This program is free software; you can redistribute it and/or modify
- it under the terms of the GNU General Public License as published by
- the Free Software Foundation; either version 2 of the License, or
- (at your option) any later version.
-
- This program is distributed in the hope that it will be useful,
- but WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- GNU General Public License for more details.
-
- You should have received a copy of the GNU General Public License
- along with this program; if not, write to the Free Software
- Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-
-
-Also add information on how to contact you by electronic and paper mail.
-
-If the program is interactive, make it output a short notice like this
-when it starts in an interactive mode:
-
- Gnomovision version 69, Copyright (C) year name of author
- Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
- This is free software, and you are welcome to redistribute it
- under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License. Of course, the commands you use may
-be called something other than `show w' and `show c'; they could even be
-mouse-clicks or menu items--whatever suits your program.
-
-You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a "copyright disclaimer" for the program, if
-necessary. Here is a sample; alter the names:
-
- Yoyodyne, Inc., hereby disclaims all copyright interest in the program
- `Gnomovision' (which makes passes at compilers) written by James Hacker.
-
- <signature of Ty Coon>, 1 April 1989
- Ty Coon, President of Vice
-
-This General Public License does not permit incorporating your program into
-proprietary programs. If your program is a subroutine library, you may
-consider it more useful to permit linking proprietary applications with the
-library. If this is what you want to do, use the GNU Library General
-Public License instead of this License.
diff --git a/COPYING.md b/COPYING.md
new file mode 100644
index 000000000..af5153d8f
--- /dev/null
+++ b/COPYING.md
@@ -0,0 +1,361 @@
+### GNU GENERAL PUBLIC LICENSE
+
+Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
+
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+### Preamble
+
+The licenses for most software are designed to take away your freedom
+to share and change it. By contrast, the GNU General Public License is
+intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users. This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it. (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.) You can apply it to
+your programs, too.
+
+When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if
+you distribute copies of the software, or if you modify it.
+
+For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have. You must make sure that they, too, receive or can get the
+source code. And you must show them these terms so they know their
+rights.
+
+We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software. If the software is modified by someone else and passed on,
+we want its recipients to know that what they have is not the
+original, so that any problems introduced by others will not reflect
+on the original authors' reputations.
+
+Finally, any free program is threatened constantly by software
+patents. We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary. To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at
+all.
+
+The precise terms and conditions for copying, distribution and
+modification follow.
+
+### TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+**0.** This License applies to any program or other work which
+contains a notice placed by the copyright holder saying it may be
+distributed under the terms of this General Public License. The
+"Program", below, refers to any such program or work, and a "work
+based on the Program" means either the Program or any derivative work
+under copyright law: that is to say, a work containing the Program or
+a portion of it, either verbatim or with modifications and/or
+translated into another language. (Hereinafter, translation is
+included without limitation in the term "modification".) Each licensee
+is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope. The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the Program
+(independent of having been made by running the Program). Whether that
+is true depends on what the Program does.
+
+**1.** You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a
+fee.
+
+**2.** You may modify your copy or copies of the Program or any
+portion of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+
+**a)** You must cause the modified files to carry prominent notices
+stating that you changed the files and the date of any change.
+
+
+**b)** You must cause any work that you distribute or publish, that in
+whole or in part contains or is derived from the Program or any part
+thereof, to be licensed as a whole at no charge to all third parties
+under the terms of this License.
+
+
+**c)** If the modified program normally reads commands interactively
+when run, you must cause it, when started running for such interactive
+use in the most ordinary way, to print or display an announcement
+including an appropriate copyright notice and a notice that there is
+no warranty (or else, saying that you provide a warranty) and that
+users may redistribute the program under these conditions, and telling
+the user how to view a copy of this License. (Exception: if the
+Program itself is interactive but does not normally print such an
+announcement, your work based on the Program is not required to print
+an announcement.)
+
+These requirements apply to the modified work as a whole. If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works. But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote
+it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+**3.** You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+
+**a)** Accompany it with the complete corresponding machine-readable
+source code, which must be distributed under the terms of Sections 1
+and 2 above on a medium customarily used for software interchange; or,
+
+
+**b)** Accompany it with a written offer, valid for at least three
+years, to give any third party, for a charge no more than your cost of
+physically performing source distribution, a complete machine-readable
+copy of the corresponding source code, to be distributed under the
+terms of Sections 1 and 2 above on a medium customarily used for
+software interchange; or,
+
+
+**c)** Accompany it with the information you received as to the offer
+to distribute corresponding source code. (This alternative is allowed
+only for noncommercial distribution and only if you received the
+program in object code or executable form with such an offer, in
+accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it. For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable. However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+**4.** You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License. Any attempt otherwise
+to copy, modify, sublicense or distribute the Program is void, and
+will automatically terminate your rights under this License. However,
+parties who have received copies, or rights, from you under this
+License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+**5.** You are not required to accept this License, since you have not
+signed it. However, nothing else grants you permission to modify or
+distribute the Program or its derivative works. These actions are
+prohibited by law if you do not accept this License. Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+**6.** Each time you redistribute the Program (or any work based on
+the Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions. You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+**7.** If, as a consequence of a court judgment or allegation of
+patent infringement or for any other reason (not limited to patent
+issues), conditions are imposed on you (whether by court order,
+agreement or otherwise) that contradict the conditions of this
+License, they do not excuse you from the conditions of this License.
+If you cannot distribute so as to satisfy simultaneously your
+obligations under this License and any other pertinent obligations,
+then as a consequence you may not distribute the Program at all. For
+example, if a patent license would not permit royalty-free
+redistribution of the Program by all those who receive copies directly
+or indirectly through you, then the only way you could satisfy both it
+and this License would be to refrain entirely from distribution of the
+Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices. Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+**8.** If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded. In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+**9.** The Free Software Foundation may publish revised and/or new
+versions of the General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Program
+specifies a version number of this License which applies to it and
+"any later version", you have the option of following the terms and
+conditions either of that version or of any later version published by
+the Free Software Foundation. If the Program does not specify a
+version number of this License, you may choose any version ever
+published by the Free Software Foundation.
+
+**10.** If you wish to incorporate parts of the Program into other
+free programs whose distribution conditions are different, write to
+the author to ask for permission. For software which is copyrighted by
+the Free Software Foundation, write to the Free Software Foundation;
+we sometimes make exceptions for this. Our decision will be guided by
+the two goals of preserving the free status of all derivatives of our
+free software and of promoting the sharing and reuse of software
+generally.
+
+**NO WARRANTY**
+
+**11.** BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO
+WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
+EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
+OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY
+KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
+PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME
+THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+**12.** IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
+WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
+AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU
+FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
+CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
+PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
+RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
+FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF
+SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGES.
+
+### END OF TERMS AND CONDITIONS
+
+### How to Apply These Terms to Your New Programs
+
+If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these
+terms.
+
+To do so, attach the following notices to the program. It is safest to
+attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ one line to give the program's name and an idea of what it does.
+ Copyright (C) yyyy name of author
+
+ This program is free software; you can redistribute it and/or
+ modify it under the terms of the GNU General Public License
+ as published by the Free Software Foundation; either version 2
+ of the License, or (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+Also add information on how to contact you by electronic and paper
+mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+ Gnomovision version 69, Copyright (C) year name of author
+ Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
+ type `show w'. This is free software, and you are welcome
+ to redistribute it under certain conditions; type `show c'
+ for details.
+
+The hypothetical commands \`show w' and \`show c' should show the
+appropriate parts of the General Public License. Of course, the
+commands you use may be called something other than \`show w' and
+\`show c'; they could even be mouse-clicks or menu items--whatever
+suits your program.
+
+You should also get your employer (if you work as a programmer) or
+your school, if any, to sign a "copyright disclaimer" for the program,
+if necessary. Here is a sample; alter the names:
+
+ Yoyodyne, Inc., hereby disclaims all copyright
+ interest in the program `Gnomovision'
+ (which makes passes at compilers) written
+ by James Hacker.
+
+ signature of Ty Coon, 1 April 1989
+ Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library,
+you may consider it more useful to permit linking proprietary
+applications with the library. If this is what you want to do, use the
+[GNU Lesser General Public
+License](http://www.gnu.org/licenses/lgpl.html) instead of this
+License. \ No newline at end of file
diff --git a/NEWS b/NEWS
deleted file mode 100644
index a81aaf9ab..000000000
--- a/NEWS
+++ /dev/null
@@ -1,443 +0,0 @@
-NEWS for ghdl (Dunoon Edition)
-
-New in 0.35 (XXXX-XX-XX)
-* Assert and report messages are sent to stdout (#394)
-
-New in 0.34 (2017-08-15)
-* Display stack backtraces on errors or assert failures
-* Compile scripts for vendor libraries (Xilinx, Altera, osvvm, vunit)
-* Use SSE2 for mcode backend
-* Mode backend ported to x86_64
-* Support cocotb (https://github.com/potentialventures/cocotb)
-* Main repository is now on github: https://github.com/tgingold/ghdl
-* Docs available on rtd: https://ghdl.readthedocs.org/en/latest/
-* Speed improved.
-* New option --psl-report, to report status of psl assert and cover.
-* vhdl 2008: support nested packages
-
-New in 0.33 (2015-10-04)
-* Improve support of vhdl 2008
-* Support OSVVM 2015 (http://osvvm.org)
-* Support vunit (https://github.com/LarsAsplund/vunit)
-* Many bugs fixed
-
-New in 0.32 (2014-11-XX)
-* Updated to build with gcc-4.9.2.
-* Partial support of VHDL-2008 (available with --std=08):
-* support of new std.env package.
-* support of added features in std.textio package
-* support of all standard IEEE packages.
-* support of new operations (relation operators, maximum and minimum, unary
- reduction operators)
-* support of boolean_vector, integer_vector, real_vector.
-* support of process(all).
-* support of generic packages and interface package declarations.
-* support of block comments (aka delimited comments)
-* support of implicitely defined to_string functions.
-* Support OSVVM 2014_01
-* Bugs fixed
-
-New in 0.31 (2014-01-XX)
-* Updated to build with gcc-4.8.2.
-* Supports OSVVM (Open-Source VHDL Verification Methodology) (see osvvm.org)
- in its VHDL-2002 form.
-* Adds 'image and 'value attributes for all required datatypes
-* Many bugs and support issues fixed.
-* New home on https://sourceforge.net/projects/ghdl-updates/
-
-New in 0.30
-Never released, swith to Dunoon Edition.
-
-New in 0.29 (2010-01-09)
-* Initial implementation of embedded PSL assertions.
-* Improve speed of non-sensitized processes.
-* Improve speed of string case statement (dichotomy instead of linear search).
-* bug fix and improvments in SDF annotator.
-* bug fix when the bound of a string literal type is not locally static.
-* bug fix: gcov crash
-
-New in 0.28 (2009-09-17)
-* Add --std=08 to enable vhdl 2008 features.
-* Support all-sensitized processes from vhdl 2008.
-* bug fix: handle 'pos/'leftof/'rightof/'succ/'pred in concurrent statements.
-* bug fix: overloaded resolution functions.
-* bug fix: direct drivers elaboration for unconstrained array signals.
-* Documentation typos (thanks to Peter Huewe).
-* many minor bugs fixed.
-
-New in 0.27 (2008-07-01)
-* Improve SDF annotation (handles much more annotations)
-* Add --ieee-asserts= option to control assert messages from ieee packages.
-* bug fix: aliases in port map
-* bug fix: crash during elaboration for top entities with ports/generic
-* bug fix: crash when string literal in aggregate.
-* bug fix: concatenation with an array subtype element.
-* bug fix: non-static subtype used by type conversions in associations.
-* bug fix: clear timeout in wait for.
-* minor bugs fixed.
-
-New in 0.26 (2007-04-08)
-* GHDL_PREFIX environment variable overrides default installation prefix.
-* simulation speed improved with 'direct drivers'.
-* windows version: exceptions are caught
-* windows version: use executable path instead of registry for prefix
-* bug fix: individual association by expression (was not working)
-* bug fix: individual association of string
-* bug fix: within windows code generator
-* bug fix (windows): large local variables crashed
-* bug fix: crash when overloaded aggregate target.
-* bug fix: forbid individual association with open
-* bug fix: crash when bad array prefix
-* bug fix: correctly extract sensitivity of record aggregate
-
-New in 0.25 (2006-08-11)
-* bug fix: ieee math libraries available when --ieee=synopsys.
-* bug fix: 'image in package bodies.
-* bug fix: scan of fp literals.
-* bug fix: interface identifier is checked for conformance rules.
-* bug fix: avoid a crash in case of error in configuration specification.
-* bug fix: non-static choice in unidim case are now correctly checked.
-* bug fix: do not crash in case of bad use of incomplete type.
-* bug fix: 'range are not expressions.
-* bug fix: handle file declaration in concurrent procedure calls.
-* bug fix: correctly handle static 'image attribute.
-* bug fix: handle in-conversion for signal associated with an expression.
-* bug fix: emit an error when a function tries to exit without a return.
-* vpi functions to schedules values.
-* math_real now works under windows.
-* documentation updated for windows.
-* filename/line number displayed for range error during signal update.
-
-New in 0.24 (2006-06-25)
-* bug fix: correctly handle empty file name.
-* bug fix: correctly handle unused subprograms of protected types.
-* bug fix: avoid a crash if unused library are use'd.
-* bug fix: avoid crashes during error reports.
-* bug fix: add a missing case array conversion.
-* bug fix: build on x86_64.
-* bug fix: code generated for conversion after mod/rem (windows version).
-* bug fix: -fexplicit crashed with std.standard functions.
-* bug fix: handle recursion of pure/wait checks.
-* bug fix: correctly handle error cases of user attributes
-* bug fix: time and character read procedure of std.textio.
-* bug fix: initialize by value parameters (instead of copy-in).
-* Handle enums with more than 256 elements.
-* Relax expr static rules in 93c to analyze Xilinx core lib from 8.1
-* man page (ghdl.1) added.
-* windows installer improved
-
-New in 0.23 (2006-05-16)
-* bug fix: handle implicit conversion in resolution functions.
-* bug fix: missing implicit conversion added.
-* bug fix: avoid a crash in error.
-
-New in 0.22 (2006-03-28)
-* direntry added in ghdl.texi
-* bug fix: avoid crash if type conversion is indexed/sliced.
-* bug fix: do not allow anymore uncomplete individual association
-* bug fix: missing check on array association
-* bug fix: check bounds for val attribute on enumerated type.
-* bug fix: array inequality of locally static expressions evaluated.
-* bug fix: configuration issue.
-* bug fix: --warn-no-vital-generic is now working.
-* Documentation updated (explain bug in Xilinx unisim library).
-* Updated to gcc 4.1
-* math_real updated.
-
-New in 0.21 (2005-12-18)
-* bug fix: line number for some bound violation messages.
-* bug fix: improved message error for deferred constants.
-* bug fix: file parameter for functions.
-* bug fix: universal real divided by integer handled in locally static expr.
-* bug fix: std_ulogic types and arrays are known by vpi.
-* bug fix: missing space added in VCDs for integers.
-* bug fix: CR+LF is also end of line for std.textio.readline.
-* bug fix: avoid a crash if parse error on choice.
-* bug fix: handle 'image in nested subprograms.
-* bug fix: handle 'image for floating point types.
-* bug fix: do not use varargs C calls.
-* bug fix: handle missing EOL for readline.
-* local optimizations (loops, indexed name).
-* simulation speed improved by 20% due to processes mngt optimizations.
-* stack-switching code ported to x86_64 (amd64/em64t).
-* stack-switching code ported to ia64.
-* bug fixes for x86_64.
-* --syn-binding option extended (see documentation).
-
-New in 0.20 (2005-10-15)
-* stack memory usage improved for shortcurt operations.
-* gtkwave now displays nice waves for bit and std_ulogic signals.
-* time unit is displayed in assert/report message.
-* -fexplicit option added.
-* integers are now written in VCD files.
-* hash table added for design_units (speed optimization).
-* range checks slightly optimized.
-* --vcdz run time option added.
-* improved error message for invalid expressions.
-* grt now compiles with GNAT-GPL-2005 (use a GNAT bug work-around).
-* bug fix: handle more types for --dump-rti and --wave.
-* bug fix: 'last_event and 'last_active (bad value returned when no previous
- event or activity).
-* bug fix: 'image attribute for physical types (was bad unit).
-* bug fix: 'image attribute for locally static integers.
-* bug fix: for reading .ghw files.
-* bug fix: in --xref.
-
-New in 0.19 (2005-08-17)
-* bug fix: internal error (missing close_temp for implicit read)
-* bug fix: --xref-html: avoid to reanalyze unit.
-* bug fix: handle implicit conversion for 'image.
-* bug fix: aggregate assigned to an aggregate: avoid crash.
-* bug fix: array attributes on unconstrained array: avoid crash.
-* bug fix: 'last_event returns time'high if no event.
-* bug fix: 'last_event on array (uninitialized variable).
-* bug fix: allow calling rising_edge with a port of mode buffer.
-* bug fix: allow aliases of unconstrained arrays.
-* bug fix: bound error on aggregate with an unused other association.
-* bug fix: catch indexed/sliced component (was crashing).
-* bug fix: catch index/slice of a type conversion (was crashing).
-* bug fix: handle bad component specification in conf (was crashing).
-* bug fix: missing ports in component (was crashing).
-* bug fix: component configurations were dicarded by bug in some cases.
-* bug fix: no more unused warnings for subprograms in architectures
- (they may be used in configuration).
-* bug fix: allow conversion in component configuration.
-* bug fix: conversion in associations with not statically defined array
- signals.
-* ADAFLAGS has been replaced by GHDL_ADAFLAGS to ease compilation.
-* ieee.math_real and ieee.math_complex added (only partially, based on a
- draft).
-* current time is printed with assert/report messages.
-* stack switch assembly code ported to powerpc-linux.
-* documentation on how to use grt from Ada added.
-* allow indexes of indexed names to be non-static in case statements (93c only)
- (this is not standard, but I can't see why it should be required).
-* unbound ports of entities are now reported with --warn-binding.
-* some error or warning messages improved.
-* --wave option added to dump waveforms (using ghw file format).
-
-New in 0.18 (2005-03-12)
-* bug fix: in textio.read for time.
-* bug fix: file_close does not crash if file was already closed.
-* bug fix: spurious unused warnings for protected types.
-* bug fix: allow subtype names in slice during sensitivity extraction.
-* bug fix: correctly set the default value of collapsed ports.
-* bug fix: handling of stack2 (aka large concatenation bug).
-* Keep last line number to speed-up line number look-up (improvement).
-* --warn-default-binding added, --warn-binding rewritten.
-* 'value implemented for integer numbers.
-
-New in 0.17 (2005-02-26)
-* command --elab-run added.
-* Code generation for aggregate improved.
-* bug fix: port map with expression (corner case ?).
-* Library name of option --work= is checked.
-* bug fix: forbid empty extended identifiers.
-* --no-run option added to prevent simulation (may be used to disp tree only).
-* disp signal name in error when multiple sources drive an unresolved signal.
-* -m/--gen-makefile now handle several libraries.
-* dependences are not stored anymore in libraries (shorter/faster).
-* bug fix: enumeration literal xrefs.
-* mentor version of ieee library is now provided.
-* bug fix: non-object name in sensitivity list crashed.
-* handling of universal types is more consistent with LRM
- (almost corner cases).
-* iterator and indexes whose bounds were universal expressions are now
- of type integer or erroneous, according to the weird LRM rules.
-* handle selected name as entity name in architecture/configuration.
-* bug fix: correctly handle alias of signals in processes.
-
-New in 0.16 (2005-01-02)
-* bug fix: better handling of errors in type conversion.
-* bug fix: few uninitialized variables in ghdl itself caught.
-* std.textio: readline has no limits on line length.
-* bug fix: parse error: 'begin' in aggregates.
-* bug fix: bad 'unused subprogram' warnings.
-* command -r (run) added.
-
-New in 0.15 (2004-10-13)
-* library file format modified to handle relative paths.
-* install fixed to use relative paths.
-* internal change: ortho API modified (constant are not anymore expressions).
-
-New in 0.14 (2004-08-29)
-* bug fix: resolution function can be an expanded name.
-* bug fix: missing type check in a corner case.
-* bug fix: emit an error when EOF is reached while a text file is read.
-* bug fix: std.textio.read for negative number.
-* bug fix: std.textio.read [integer]: correctly handle end of line.
-* bug fix: parameters of protected type: handled and checked.
-* bug fix: gen_tree.c modified to work with sparc.
-* pretty printing in HTML command (--pp-html) added.
-* xref generation in HTML command (--xref-html) added.
-* syntax checking command (-s) added.
-* Code generation in whole command (-c files -e unit) added.
-* warns for unused subprograms.
-* bug box added to help bug reports.
-* -s (syntax check) command added.
-* Missing grt subprogram to close non-text file added.
-* maximum line length of std.textio.readline extended to 512 characters.
-* std.textio.readline assert error on truncated lines.
-* Handle P32 and P64 in --trace-signals
-* sequentials statements are not canonicalized (should be faster).
-* DESTDIR added in Makefile to ease packaging.
-* for -m command, re-parse modified files of the work library.
-* Many checks added on interfaces.
-* Many checks added on associations, better handling of conversions.
-* Checks for unassociated entity ports at elaboration.
-
-New in 0.13 (2004-06-26)
-* support of 64bits integers and 32bits time (not yet user available)
-* handle 'high and 'low attributes on non-locally static types and subtypes.
-* Many warning switches added (to control output of warnings).
-* --gen-makefile mode added to ghdl (to generate a Makefile)
-* alias identifier restrictions of vhdl-02 implemented.
-* declarative region for architecture from vhdl-02 implemented.
-* buffer port association rules of vhdl-02 implemented.
-* method operator restrictions of vhdl-02 implemented.
-* 'driving and 'driving_value implemented.
-* run-time bound check error message now contains file name and line number.
-* strings are not stored anymore with the identifiers.
-* parser does not back-track anymore.
-* bug fix: name clash in generated .s files (arch and port/generic names).
-* bug fix: implicit conversion of signal parameters.
-* bug fix: handle locally static type conversion of arrays.
-* bug fix: stabilize during elaboration of an unconstrained signal.
-* bug fix: revert previous vhdl87 conf spec bug fix, according to INT-1991
- issue 27.
-* bug fix: multiple visibility of declarations (eg: direct and alias).
-* bug fix: names attribute of non-object aliases.
-
-New in 0.12 (2004-05-30)
-* simulation speed improved (2 fold) due to reduced activity optimization.
-* type conversion handled in associations
-* make mode of ghdl improved.
-* bug fix: attribute specification
-* bug fix: allow discrete type marks in choices
-* bug fix: handling of generate statement for VCD
-* bug fix: allow dereference in variable associations
-* bug fix: allow function conversion in block port map
-* bug fix: vhdl87: apply configuration specification inside generate stmts.
-* bug fix: catch non-passive concurrent procedure calls in entity.
-* bug fix: association of an unconstrained port with an expression.
-* bug fix: declaring an uncons. array subtype of an uncons. array subtype.
-
-New in 0.11.1 (2004-04-24)
-* bug fix: corner case of signal not updated
-* bug fix: handle 'stable, 'quiet with a paramater > 0
-* bug fix: typos (missing '+ ') in sparc.S
-
-New in 0.11 (2004-04-17)
-* bug fix: in code generation for an aggregate.
-* bug fix: run-time check of ascending order of projected transactions.
-* bug fix: empty sequence of stmts in case alternatives (unidim array).
-* bug fix: evaluation of locally static 'range attribute.
-* signal collapsing improved.
-* simulation kernel speed improved (maybe 5x faster).
-* --lines mode of ghdldrv added.
-* boolean signals are now dumped in vcd files.
-* bug fix: implicit conversion in formal function convertor.
-* bug fix: return type is a type mark.
-
-New in 0.10 (2004-02-28)
-* architecture with many instances can be compiled with less memory.
-* --stats option added to the simulator, to evaluate performance.
-* signals are now collapsed between instances, if possible.
-* simulation is about 3x faster.
-* sparc port available (source only).
-* more checks added for attribute specification.
-* bug fixed: absolute source files.
-* chop command added (split files by design unit).
-* bug fixed: empty sequence of statements in case alternatives.
-
-New in 0.9 (2004-02-01)
-* VITAL level 0 restrictions checks added.
-* VITAL 2000 packages provided.
-* run-time information (such as signal names) rewritten.
-* SDF support added (partial and experimental).
-* bug fixed: allow elaboration even if no package body if the package is
- present in a file but not used by the hierarchy.
-* bug fixed: delay_length range is pre-elaborated (was not in v93).
-* bug fixed: crashed when a design unit is not found at elaboration.
-* bug fixed: allow association of 'stable, 'quiet... with signal interfaces.
-* bug fixed: concurrent procedure call creates a non-sensitized process.
-* bug fixed: effective value of non-scalar resolved signal might not be set.
-
-New in 0.8 (2003-11-05)
-* protected types (from 1076a/1076-2000) implemented.
-* file declarations are finalized in subprograms.
-* an exit call-back has been added in the run-time library.
-* internal modifications (nodes are stored in a table).
-* signal declaration not allowed in processes (bug fixed).
-* name of generated executable can be set with '-o' option.
-* IVI (ivi.sourceforge.org) support through a few VPI subprograms.
-* pure and wait checks added.
-* out ports are correctly dumped in VCD files.
-* several bugs fixed.
-
-New in 0.7 (2003-08-02)
-* layout of internal nodes improved.
-* incremental binding (vhdl93).
-* association of in port with expressions (vhdl93).
-* instantiation added in hierarchy (bug fixed).
-* individual association of subelements by expression (bug fixed).
-* --disp-time option added.
-* --stop-delta option is working (bug fixed).
-* make mode (ghdl -m) rewritten.
-* 'simple_name, 'path_name and 'instance_name added (vhdl93).
-* correctly handle operators names at function call (bug fixed).
-* several small bugs fixed.
-
-New in 0.6 (2003-06-09)
-* internal modifications (single linked list used instead of arrays).
-* bug fixed: xnor on bit and boolean is working.
-* Mentor version of std_logic_arith is provided.
-* postponed handled (vhdl 93).
-* declarations allowed in a generate statement (vhdl 93).
-* bug fixed: selected_name list in use clauses.
-* non object aliases handled (vhdl93).
-* signatures handled (vhdl93).
-* many other small bug fixes.
-
-New in 0.5 (2003-05-10)
-* foreign attribute handled. You can now call subprograms defined in a foreign
- language (such as C or Ada).
-* ghdl entry point added: you can start the VHDL simulation from your own
- program.
-* bug fixed: triple use.
-* bug fixed: incomplete types
-
-New in 0.4.1 (2003-04-07)
-* bug fixed in the vcd output.
-
-New in 0.4 (2003-04-02)
-* libgrt does not depend on GNAT library anymore.
- Installation requirements are reduced.
-* 'delayed attribute implemented.
-* 'transaction attribute implemented.
-* unaffected (from vhdl-93) implemented.
-* ghdl action '--disp-standard' prints the std.standard package.
-* exponentiation operator ("**") implemented for all integer and floating
- point types.
-* bug fix: subprogram interfaces are now elaborated.
-* many other small bug fixes.
-
---------------------------------------------------
-
-Contributors to ghdl:
-
-Tristan Gingold (sole author of ghdl as a whole)
-Brian Drummond (gcc4.8.2 update, OSVVM port, some bugfixes)
-David Koontz (Mac OSX builds, LRM compliance work, bugfix analyses)
-Joris van Rantwijk (Debian packaging)
-Brian Davis (Windows Mcode builds)
-Adam Jensen (FreeBSD builds)
-Felix Bertram (VPI interface)
-
-with apologies to anyone who ought to be on this list but isn't.
-Thanks also to all those who have reported bugs and support issues,
-and often patches and testcases to either:
-https://gna.org/bugs/?group=ghdl
-or
-https://sourceforge.net/p/ghdl-updates/tickets/
-
diff --git a/NEWS.md b/NEWS.md
new file mode 100644
index 000000000..9aedc6596
--- /dev/null
+++ b/NEWS.md
@@ -0,0 +1,440 @@
+# NEWS for ghdl (Dunoon Edition)
+
+**v0.34-dev**
+* Display stack backtraces on errors or assert failures
+* Compile scripts for vendor libraries (Xilinx, Altera, osvvm, vunit)
+* Use SSE2 for mcode backend
+* Mode backend ported to `x86_64`
+* Support cocotb [potentialventures/cocotb](https://github.com/potentialventures/cocotb)
+* Main repository is now on github: [github.com/tgingold/ghdl](https://github.com/tgingold/ghdl)
+* Docs available on rtd: [ghdl.readthedocks.org](https://ghdl.readthedocs.org/en/latest/)
+* Speed improved.
+* New option `--psl-report`, to report status of PSL assert and cover.
+* VHDL2008: support nested packages
+
+**v0.33** (2015-10-04)
+* Improve support of VHDL2008
+* Support [OSVVM](http://osvvm.org) 2015
+* Support VUnit: [LarsAsplund/vunit](https://github.com/LarsAsplund/vunit)
+* Many bugs fixed
+
+**v0.32** (2014-11-XX)
+* Updated to build with `gcc-4.9.2`.
+* support:
+ * partial of VHDL2008 (available with `--std=08`):
+ * new `std.env` package.
+ * added features in `std.textio` package
+ * all standard IEEE packages.
+ * new operations (relation operators, maximum and minimum, unary reduction operators)
+ * `boolean_vector`, `integer_vector`, `real_vector`.
+ * process(all).
+ * generic packages and interface package declarations.
+ * block comments (aka delimited comments)
+ * implicitely defined to_string functions.
+ * OSVVM 2014_01
+* Bugs fixed
+
+**v0.31** (2014-01-XX)
+* Updated to build with `gcc-4.8.2`.
+* Supports OSVVM (Open-Source VHDL Verification Methodology) (see [osvvm.org](http://osvvm.org)) in its VHDL-2002 form.
+* Adds `'image` and `'value` attributes for all required datatypes
+* Many bugs and support issues fixed.
+* New home on `https://sourceforge.net/projects/ghdl-updates/`
+
+**v0.30**
+Never released, swith to Dunoon Edition.
+
+**v0.29** (2010-01-09)
+* Initial implementation of embedded PSL assertions.
+* Improve:
+ * speed of non-sensitized processes.
+ * speed of string case statement (dichotomy instead of linear search).
+* bug fix:
+ * and improvements in SDF annotator.
+ * when the bound of a string literal type is not locally static.
+ * gcov crash
+
+**v0.28** (2009-09-17)
+* Add `--std=08` to enable VHDL2008 features.
+* Support all-sensitized processes from VHDL2008.
+* Documentation typos (thanks to Peter Huewe).
+* bug fix:
+ * handle `'pos/'leftof/'rightof/'succ/'pred` in concurrent statements.
+ * overloaded resolution functions.
+ * direct drivers elaboration for unconstrained array signals.
+ * many minor bugs.
+
+**v0.27** (2008-07-01)
+* Improve SDF annotation (handles much more annotations)
+* Add `--ieee-asserts=` option to control assert messages from ieee packages.
+* bug fix:
+ * aliases in port map
+ * crash during elaboration for top entities with ports/generic
+ * crash when string literal in aggregate.
+ * concatenation with an array subtype element.
+ * non-static subtype used by type conversions in associations.
+ * clear timeout in wait for.
+ * minor bugs.
+
+**v0.26** (2007-04-08)
+* `GHDL_PREFIX` environment variable overrides default installation prefix.
+* simulation speed improved with 'direct drivers'.
+* windows version:
+ * exceptions are caught
+ * use executable path instead of registry for prefix
+* bug fix:
+ * individual association by expression (was not working)
+ * individual association of string
+ * within windows code generator
+ * [windows] large local variables crashed
+ * crash when overloaded aggregate target.
+ * forbid individual association with open
+ * crash when bad array prefix
+ * correctly extract sensitivity of record aggregate
+
+**v0.25** (2006-08-11)
+* VPI functions to schedules values.
+* `math_real` now works under windows.
+* documentation updated for windows.
+* filename/line number displayed for range error during signal update.
+* bug fix:
+ * ieee math libraries available when `--ieee=synopsys`.
+ * `'image` in package bodies.
+ * scan of fp literals.
+ * interface identifier is checked for conformance rules.
+ * avoid a crash in case of error in configuration specification.
+ * non-static choice in unidim case are now correctly checked.
+ * do not crash in case of bad use of incomplete type.
+ * `'range` are not expressions.
+ * handle file declaration in concurrent procedure calls.
+ * correctly handle static `'image` attribute.
+ * handle in-conversion for signal associated with an expression.
+ * emit an error when a function tries to exit without a return.
+
+**v0.24** (2006-06-25)
+* Handle enums with more than 256 elements.
+* Relax expr static rules in 93c to analyze Xilinx core lib from 8.1
+* man page, `ghdl.1`, added.
+* windows installer improved
+* bug fix:
+ * correctly handle empty file name.
+ * correctly handle unused subprograms of protected types.
+ * avoid a crash if unused library are used.
+ * avoid crashes during error reports.
+ * add a missing case array conversion.
+ * build on `x86_64`.
+ * code generated for conversion after mod/rem (windows version).
+ * `-fexplicit` crashed with `std.standard` functions.
+ * handle recursion of pure/wait checks.
+ * correctly handle error cases of user attributes
+ * time and character read procedure of std.textio.
+ * initialize by value parameters (instead of copy-in).
+
+**v0.23** (2006-05-16)
+* bug fix:
+ * handle implicit conversion in resolution functions.
+ * missing implicit conversion added.
+ * avoid a crash in error.
+
+**v0.22** (2006-03-28)
+* direntry added in `ghdl.texi`
+* updated:
+ * Documentation (explain bug in Xilinx unisim library).
+ * to `gcc 4.1`
+ * math_real
+* bug fix:
+ * avoid crash if type conversion is indexed/sliced
+ * do not allow anymore uncomplete individual association
+ * missing check on array association
+ * check bounds for val attribute on enumerated type
+ * array inequality of locally static expressions evaluated
+ * configuration issue
+ * `--warn-no-vital-generic` is now working
+
+**v0.21** (2005-12-18)
+* local optimizations (loops, indexed name).
+* simulation speed improved by 20% due to processes mngt optimizations.
+* stack-switching code ported to `x86_64` (`amd64/em64t`).
+* stack-switching code ported to `ia64`.
+* `--syn-binding` option extended (see documentation).
+* bug fix:
+ * line number for some bound violation messages.
+ * improved message error for deferred constants.
+ * file parameter for functions.
+ * universal real divided by integer handled in locally static expr.
+ * `std_ulogic` types and arrays are known by VPI.
+ * missing space added in VCDs for integers.
+ * `CR+LF` is also end of line for `std.textio.readline`.
+ * avoid a crash if parse error on choice.
+ * handle `'image` in nested subprograms.
+ * handle `'image` for floating point types.
+ * do not use varargs C calls.
+ * handle missing `EOL` for `readline`.
+ * for `x86_64`
+
+**v0.20** (2005-10-15)
+* stack memory usage improved for shortcurt operations.
+* gtkwave now displays nice waves for bit and std_ulogic signals.
+* time unit is displayed in assert/report message.
+* `-fexplicit` option added.
+* integers are now written in VCD files.
+* hash table added for design_units (speed optimization).
+* range checks slightly optimized.
+* `--vcdz` run time option added.
+* improved error message for invalid expressions.
+* grt now compiles with GNAT-GPL-2005 (use a GNAT bug work-around).
+* bug fix:
+ * handle more types for `--dump-rti` and `--wave`.
+ * `'last_event` and `'last_active` (bad value returned when no previous event or activity).
+ * `'image` attribute for physical types (was bad unit).
+ * `'image` attribute for locally static integers.
+ * for reading `.ghw` files.
+ * in `--xref`.
+
+**v0.19** (2005-08-17)
+* `ADAFLAGS` has been replaced by `GHDL_ADAFLAGS` to ease compilation.
+* `ieee.math_real` and `ieee.math_complex` added (only partially, based on a
+ draft).
+* current time is printed with assert/report messages.
+* stack switch assembly code ported to powerpc-linux.
+* documentation on how to use grt from Ada added.
+* allow indexes of indexed names to be non-static in case statements (93c only)
+ (this is not standard, but I can't see why it should be required).
+* unbound ports of entities are now reported with `--warn-binding`.
+* some error or warning messages improved.
+* `--wave` option added to dump waveforms (using ghw file format).
+* bug fix:
+ * internal error (missing close_temp for implicit read)
+ * `--xref-html`: avoid to reanalyze unit.
+ * handle implicit conversion for `'image`.
+ * aggregate assigned to an aggregate: avoid crash.
+ * array attributes on unconstrained array: avoid crash.
+ * `'last_event` returns `time'high` if no event.
+ * `'last_event` on array (uninitialized variable).
+ * allow calling `rising_edge` with a port of mode buffer.
+ * allow aliases of unconstrained arrays.
+ * bound error on aggregate with an unused other association.
+ * catch indexed/sliced component (was crashing).
+ * catch index/slice of a type conversion (was crashing).
+ * handle bad component specification in conf (was crashing).
+ * missing ports in component (was crashing).
+ * component configurations were dicarded by bug in some cases.
+ * no more unused warnings for subprograms in architectures (they may be used in configuration).
+ * allow conversion in component configuration.
+ * conversion in associations with not statically defined array signals.
+
+**v0.18** (2005-03-12)
+* Keep last line number to speed-up line number look-up (improvement).
+* `--warn-default-binding` added, `--warn-binding` rewritten.
+* `'value` implemented for integer numbers.
+* bug fix:
+ * in `textio.read` for time.
+ * `file_close` does not crash if file was already closed.
+ * spurious unused warnings for protected types.
+ * allow subtype names in slice during sensitivity extraction.
+ * correctly set the default value of collapsed ports.
+ * handling of stack2 (aka large concatenation bug).
+
+**v0.17** (2005-02-26)
+* command `--elab-run` added.
+* Code generation for aggregate improved.
+* Library name of option `--work=` is checked.
+* `--no-run` option added to prevent simulation (may be used to disp tree only).
+* disp signal name in error when multiple sources drive an unresolved signal.
+* `-m`/`--gen-makefile` now handle several libraries.
+* dependences are not stored anymore in libraries (shorter/faster).
+* mentor version of ieee library is now provided.
+* handling of universal types is more consistent with LRM (almost corner cases).
+* iterator and indexes whose bounds were universal expressions are now of type integer or erroneous, according to the weird LRM rules.
+* handle selected name as entity name in architecture/configuration.
+* bug fix:
+ * port map with expression (corner case ?).
+ * forbid empty extended identifiers.
+ * enumeration literal xrefs.
+ * non-object name in sensitivity list crashed.
+ * correctly handle alias of signals in processes.
+
+**v0.16** (2005-01-02)
+* `std.textio`: readline has no limits on line length.
+* command `-r` (run) added.
+* bug fix:
+ * better handling of errors in type conversion.
+ * few uninitialized variables in ghdl itself caught.
+ * parse error: `begin` in aggregates.
+ * bad `unused subprogram` warnings.
+
+**v0.15** (2004-10-13)
+* library file format modified to handle relative pathes.
+* install fixed to use relative pathes.
+* internal change: ortho API modified (constant are not anymore expressions).
+
+**v0.14** (2004-08-29)
+* pretty printing in HTML command, `--pp-html`, added.
+* xref generation in HTML command, `--xref-html`, added.
+* syntax checking command, `-s`, added.
+* Code generation in whole command, `-c files -e unit`, added.
+* warns for unused subprograms.
+* bug box added to help bug reports.
+* `-s` (syntax check) command added.
+* Missing grt subprogram to close non-text file added.
+* maximum line length of `std.textio.readline` extended to 512 characters.
+* `std.textio.readline` assert error on truncated lines.
+* Handle P32 and P64 in `--trace-signals`
+* sequentials statements are not canonicalized (should be faster).
+* `DESTDIR` added in Makefile to ease packaging.
+* for `-m` command, re-parse modified files of the work library.
+* Many checks added on interfaces.
+* Many checks added on associations, better handling of conversions.
+* Checks for unassociated entity ports at elaboration.
+* bug fix:
+ * resolution function can be an expanded name.
+ * missing type check in a corner case.
+ * emit an error when `EOF` is reached while a text file is read.
+ * `std.textio.read` for negative number.
+ * `std.textio.read` [integer]: correctly handle end of line.
+ * parameters of protected type: handled and checked.
+ * `gen_tree.c` modified to work with sparc.
+
+**v0.13** (2004-06-26)
+* support of 64bits integers and 32bits time (not yet user available)
+* handle `'high` and `'low` attributes on non-locally static types and subtypes.
+* Many warning switches added (to control output of warnings).
+* `--gen-makefile` mode added to ghdl (to generate a Makefile)
+* alias identifier restrictions of vhdl-02 implemented.
+* declarative region for architecture from vhdl-02 implemented.
+* buffer port association rules of vhdl-02 implemented.
+* method operator restrictions of vhdl-02 implemented.
+* `'driving` and `'driving_value` implemented.
+* run-time bound check error message now contains file name and line number.
+* strings are not stored anymore with the identifiers.
+* parser does not back-track anymore.
+* bug fix:
+ * name clash in generated `.s` files (arch and port/generic names).
+ * implicit conversion of signal parameters.
+ * handle locally static type conversion of arrays.
+ * stabilize during elaboration of an unconstrained signal.
+ * revert previous `vhdl87` conf spec bug fix, according to INT-1991 issue 27.
+ * multiple visibility of declarations (eg: direct and alias).
+ * names attribute of non-object aliases.
+
+**v0.12** (2004-05-30)
+* simulation speed improved (2 fold) due to reduced activity optimization.
+* type conversion handled in associations
+* make mode of ghdl improved.
+* bug fix:
+ * attribute specification
+ * allow discrete type marks in choices
+ * handling of generate statement for VCD
+ * allow dereference in variable associations
+ * allow function conversion in block port map
+ * vhdl87: apply configuration specification inside generate stmts.
+ * catch non-passive concurrent procedure calls in entity.
+ * association of an unconstrained port with an expression.
+ * declaring an uncons. array subtype of an uncons. array subtype.
+
+**v0.11.1** (2004-04-24)
+* bug fix:
+ * corner case of signal not updated
+ * handle `'stable`, `'quiet` with a paramater > 0
+ * typos (missing `+ `) in sparc.S
+
+**v0.11** (2004-04-17)
+* signal collapsing improved.
+* simulation kernel speed improved (maybe 5x faster).
+* `--lines` mode of ghdldrv added.
+* boolean signals are now dumped in vcd files.
+* bug fix:
+ * in code generation for an aggregate.
+ * run-time check of ascending order of projected transactions.
+ * empty sequence of stmts in case alternatives (unidim array).
+ * evaluation of locally static 'range attribute.
+ * implicit conversion in formal function convertor.
+ * return type is a type mark.
+
+**v0.10** (2004-02-28)
+* architecture with many instances can be compiled with less memory.
+* `--stats` option added to the simulator, to evaluate performance.
+* signals are now collapsed between instances, if possible.
+* simulation is about 3x faster.
+* sparc port available (source only).
+* more checks added for attribute specification.
+* chop command added (split files by design unit).
+* bug fix:
+ * absolute source files.
+ * empty sequence of statements in case alternatives.
+
+**v0.9** (2004-02-01)
+* VITAL level 0 restrictions checks added.
+* VITAL 2000 packages provided.
+* run-time information (such as signal names) rewritten.
+* SDF support added (partial and experimental).
+* bug fix:
+ * allow elaboration even if no package body if the package is present in a file but not used by the hierarchy.
+ * `delay_length` range is pre-elaborated (was not in v93).
+ * crashed when a design unit is not found at elaboration.
+ * allow association of `'stable`, `'quiet`... with signal interfaces.
+ * concurrent procedure call creates a non-sensitized process.
+ * effective value of non-scalar resolved signal might not be set.
+
+**v0.8** (2003-11-05)
+* protected types (from 1076a/1076-2000) implemented.
+* file declarations are finalized in subprograms.
+* an exit call-back has been added in the run-time library.
+* internal modifications (nodes are stored in a table).
+* name of generated executable can be set with `-o` option.
+* IVI (ivi.sourceforge.org) support through a few VPI subprograms.
+* pure and wait checks added.
+* out ports are correctly dumped in VCD files.
+* bug fix:
+ * signal declaration not allowed in processes.
+ * several bugs fixed.
+
+**v0.7** (2003-08-02)
+* layout of internal nodes improved.
+* incremental binding (vhdl93).
+* association of in port with expressions (vhdl93).
+* `--disp-time` option added.
+* make mode (`ghdl -m`) rewritten.
+* `'simple_name`, `'path_name` and `'instance_name` added (vhdl93).
+* bug fix:
+ * instantiation added in hierarchy.
+ * individual association of subelements by expression.
+ * `--stop-delta` option is working.
+ * correctly handle operators names at function call.
+ * several small bugs fixed.
+
+**v0.6** (2003-06-09)
+* internal modifications (single linked list used instead of arrays).
+* Mentor version of std_logic_arith is provided.
+* postponed handled (vhdl 93).
+* declarations allowed in a generate statement (vhdl 93).
+* non object aliases handled (vhdl93).
+* signatures handled (vhdl93).
+* bug fix:
+ * `xnor` on `bit` and `boolean` is working.
+ * `selected_name` list in use clauses.
+ * many other small bug fixes.
+
+**v0.5** (2003-05-10)
+* foreign attribute handled. You can now call subprograms defined in a foreign
+ language (such as C or Ada).
+* ghdl entry point added: you can start the VHDL simulation from your own
+ program.
+* bug fix:
+ * triple use.
+ * incomplete types
+
+**v0.4.1** (2003-04-07)
+* bug fix: in the vcd output.
+
+**v0.4** (2003-04-02)
+* `libgrt` does not depend on GNAT library anymore.
+ Installation requirements are reduced.
+* `'delayed` attribute implemented.
+* `'transaction` attribute implemented.
+* unaffected (from vhdl-93) implemented.
+* ghdl action `--disp-standard` prints the std.standard package.
+* exponentiation operator, `**`, implemented for all integer and floating
+ point types.
+* many other small bug fixes.
+* bug fix: subprogram interfaces are now elaborated.
diff --git a/README.md b/README.md
index d5bc30167..3b576418f 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-[![Documentation Status](https://readthedocs.org/projects/ghdl/badge/?version=latest)](http://ghdl.readthedocs.io/en/latest/?badge=latest) [![Join the chat at https://gitter.im/ghdl1/Lobby](https://badges.gitter.im/ghdl1/Lobby.svg)](https://gitter.im/ghdl1/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![GNU General Public License 2](https://img.shields.io/github/license/tgingold/ghdl.svg?style=flat)](https://github.com/tgingold/ghdl/blob/master/COPYING)
+[![Documentation Status](https://readthedocs.org/projects/ghdl/badge/?version=latest)](http://ghdl.readthedocs.io/en/latest/?badge=latest) [![Join the chat at https://gitter.im/ghdl1/Lobby](https://badges.gitter.im/ghdl1/Lobby.svg)](https://gitter.im/ghdl1/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Linux containers at Travis-CI](https://travis-ci.org/tgingold/ghdl.svg?branch=master)](https://travis-ci.org/tgingold/ghdl) [![Windows VMs at AppVeyor](https://ci.appveyor.com/api/projects/status/rsq60m5wcly3og8j?svg=true)](https://ci.appveyor.com/project/tgingold/ghdl) ![Latest tag](https://img.shields.io/github/tag/tgingold/ghdl.svg?style=flat) [![Latest release](https://img.shields.io/github/release/tgingold/ghdl.svg?style=flat)](https://github.com/tgingold/ghdl/releases)
@@ -22,7 +22,7 @@ Supported third party projects: [VUnit](https://vunit.github.io), [OSVVM](http:/
GHDL is free software:
-- [![GNU General Public License 2](https://img.shields.io/github/license/tgingold/ghdl.svg?style=flat)](https://github.com/tgingold/ghdl/blob/master/COPYING)
+- [![GNU General Public License 2](https://img.shields.io/github/license/tgingold/ghdl.svg?style=flat)](https://github.com/tgingold/ghdl/blob/master/COPYING.md)
- Doc is available on [ghdl.readthedocs.org](https://ghdl.readthedocs.org/en/latest/index.html).
- Some of the runtime libraries, are under different terms; see the individual source files for details.
@@ -34,7 +34,7 @@ You can download pre-built releases for different platforms, backends and librar
### Building GHDL
-You need the GNU Ada compiler, GNAT GPL, 2014 (or later) for x86 (32 or 64 bits). GNAT GPL can be downloaded anonymously from libre.adacore.com. Then, untar and run the doinstall script.
+You need the GNU Ada compiler, GNAT GPL, 2014 (or later) for x86 (32 or 64 bits). GNAT GPL can be downloaded anonymously from [libre.adacore.com](http://libre.adacore.com/tools/gnat-gpl-edition/). Then, untar and run the *doinstall* script.
*Depending on the OS and distribution you are using, you will also need to install some toolchain dependencies, such as `zlib`. See '[Building](http://ghdl.readthedocs.io/en/latest/building/index.html)' for specific package names.*
diff --git a/doc/building/VendorPrimitives.rst b/doc/building/VendorPrimitives.md
index b608c0825..b608c0825 100644
--- a/doc/building/VendorPrimitives.rst
+++ b/doc/building/VendorPrimitives.md
diff --git a/doc/building/index.rst b/doc/building/index.rst
index ea35d19c0..9cdc812f9 100644
--- a/doc/building/index.rst
+++ b/doc/building/index.rst
@@ -3,35 +3,173 @@
Building GHDL
#############
+GHDL currently supports three supported different backends (code generators): mcode, GCC and LLVM. Here is a short comparison, so that you can choose the one you want to use:
+
+* mcode (an internal code generator)
++ very easy to build
+- but x86_64/i386 only
++ very quick analysis time
++ can analyze very big designs
+- simulation is slower
+- no executable created
+
+* GCC
++ generated code is faster (particularly with -O or -O2)
++ generated code can be debugged (with -g)
++ the output is an executable
++ ported to many platforms (x86, x86_64, powerpc, sparc)
+- analyze can takes time (particularly for big units)
+- build is more complex
+
+* LLVM
++ same advantages of gcc (good generated code, debuggable)
++ easier to build than gcc
+
+As GHDL is written in Ada, you need to use the GNU Ada compiler (GNAT). I recommend to use GNAT GPL from http://libre.adacore.com (free). GHDL was tested with GNAT GPL 2014. Any later version should work.
+The only other dependency is zlib (On ubuntu/debian, install zlib1g-dev).
+
.. TODO::
- `./doc/oldmds/BUILD.txt <https://github.com/tgingold/ghdl/blob/master/doc/oldmds/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
+ - Very briefly, why is mode faster for analysis and GCC/LLVM for simulation?
+
+Mcode backend
=================
-- `./doc/oldmds/gcc/INSTALL <https://github.com/tgingold/ghdl/blob/master/doc/oldmds/gcc/INSTALL>`_
-- `./doc/oldmds/gcc/README <https://github.com/tgingold/ghdl/blob/master/doc/oldmds/gcc/README>`_
- Linux
+This is as simple as:
+
+$ ./configure --prefix=PREFIX
+
+ where PREFIX is the directory for installation
+
+$ make
+
+ This builds the ghdl_mcode executable, which can be used as is.
+
+$ make install
+
+ To install within PREFIX
+
+- Windows MinGW 32/64
+- Windows GNAT GPL (32 only)
+
+.. TODO::
+
+ Note: this was tested with Windows XP SP2 familly edition.
+
+ Note: If you want to create the installer, GHDL should be built on a FAT partition. NSIS rounds files date to be FAT compliant (seconds are always even) and because GHDL stores dates, the files date must not be modified.
+
+ The Ada95 GNAT compiler (GNAT GPL 2005 is known to work), along with NSIS to create the installer. Then unzip, edit winbuild to use correct path for makensis, and run winbuild. The installer is in the windows directory.
+
LLVM backend
=================
- Linux
+
+You need to build and install llvm. The supported versions are 3.5
+till 3.9, but only debugging is only supported with llvm 3.5
+(Usually llvm also depends on libedit).
+
+First configure ghdl with '--with-llvm-config'
+$ ./configure --with-llvm-config
+
+If llvm-config is not in your path, you can specify it:
+$ ./configure --with-llvm-config=LLVM_INSTALL/bin/llvm-config
+
+If you want to have stack backtraces on errors (like assert failure or
+index of out bounds), you need to configure and build libbacktrace from gcc
+(you don't need to configure gcc), and add to configure:
+ --with-backtrace-lib=/path-to-gcc-build/libbacktrace/.libs/libbacktrace.a
+
+Then build with 'make' and install with 'make install'.
+
- Mac OS?
- Windows MinGW 32/64
-
-Mcode backend
+
+GCC backend
=================
-- `./doc/oldmds/mcode/README <https://github.com/tgingold/ghdl/blob/master/doc/oldmds/windows/mcode/README>`_
- Linux
-- Windows GNAT GPL (32 only)
-- Windows MinGW 32/64
+You need to download and untar the sources of
+gcc version 4.9 [do not modify this line as this is read by scripts].
+
+First configure ghdl, specify gcc source dir and prefix.
+(replace /usr/local by your prefix directory):
+$ ./configure --with-gcc=/path/to/gcc/source/dir --prefix=/usr/local
+
+Then invoke make to copy ghdl sources in the source dir:
+$ make copy-sources
+
+There are some dependencies for building gcc (gmp, mpfr and mpc). If you have
+not them installed on your system, you can either build them manually or use
+the 'download_prerequisite' script provided in gcc source tree (recommended).
+
+$ cd /path/to/gcc/source/dir
+$ ./contrib/download_prerequisites
+
+Then configure gcc. The list of --disable configure options could be
+adjusted for your needs. GHDL don't require all these optional
+libraries and disabling them speed-up the build. Note the prefix
+directory must be the same as the one used to configure ghdl.
+If you have manually built gmp/mpfr/mpc (without using the script
+in contrib) and if you have installed them in a non-standard
+directory, you may need to add --with-gmp=GMP_INSTALL_DIR.
+
+$ mkdir gcc-objs; cd gcc-objs
+$ ../gcc-4.9.3/configure --prefix=/usr/local --enable-languages=c,vhdl \
+ --disable-bootstrap --disable-lto --disable-multilib \
+ --disable-libssp --disable-libgomp --disable-libquadmath
+$ make -j2
+
+Install gcc:
+$ make install
+or if you don't want to install makeinfo:
+$ make install MAKEINFO=true
+
+Build and install vhdl libraries:
+$ cd /path/to/ghdl/source/dir
+$ make ghdllib
+$ make install
+
+- Windows?
+
+.. TODO:
+
+ Since the content of BUILD.txt is moved to the docs, what shall we do with this line? +gcc version 6.3 [do not modify this line as this is read by scripts].
+
+ Note for ppc64 (and AIX ?) platform: the object file format contains an identifier for the source language. Because gcc doesn't know about the VHDL, gcc crashes very early. This could be fixed with a very simple change in gcc/config/rs6000/rs6000.c, function rs6000_output_function_epilogue (as of gcc 4.8):
+ else if (! strcmp (language_string, "GNU Objective-C"))
+ i = 14;
+ else
+- gcc_unreachable ();
++ i = 0;
+ fprintf (file, "%d,", i);
+
+ /* 8 single bit fields: global linkage (not set for C extern linkage,
+
+ Install file for the binary distribution of GHDL. The binary are installed in /usr/local directory. You cannot change this default location, unless you set links. You must be root to install this distribution. To install ghdl: `tar -C / -jxvf @TARFILE@.tar.bz2`. Note: you must also have a C compiler and zlib installed.
+
+- Notes for developpers
+
+Developping with the gcc backend:
+Once gcc (with ghdl) has been built once, it is possible to work on ghdl
+sources tree without copying them in gcc tree. Commands are:
+$ make ghdl1-gcc # To build the compiler
+$ make ghdl_gcc # To build the driver
+$ make libs.vhdl.local_gcc # To compile the vhdl libraries
+$ make grt-all # To build the ghdl runtime
+$ make grt.links # To locally install the ghdl runtime
+
+.. TODO::
+
+ gcc object dir
+
Test suites
=================
diff --git a/doc/conf.py b/doc/conf.py
index 08a242310..2d431acfe 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -18,6 +18,10 @@ import shlex
import re
import subprocess
+# http://docs.readthedocs.io/en/latest/getting_started.html#in-markdown
+from recommonmark.parser import CommonMarkParser
+source_parsers = { '.md': CommonMarkParser, }
+
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -55,7 +59,7 @@ templates_path = ['_templates', '_themes']
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
# source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ['.rst', '.md']
# The encoding of source files.
#source_encoding = 'utf-8-sig'
diff --git a/doc/index.rst b/doc/index.rst
index ea328da82..55bc93101 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -16,20 +16,17 @@ LRM) is a plus.
.. image:: https://badges.gitter.im/ghdl/ghdl1.svg
:target: https://gitter.im/ghdl/ghdl1
:alt: Join
+
+ .. raw:: html
+
+ <br />
+
.. image:: https://travis-ci.org/tgingold/ghdl.svg?branch=master
:target: https://travis-ci.org/tgingold/ghdl
:alt: Build status by Travis-CI
.. image:: https://ci.appveyor.com/api/projects/status/r5dtv6amsppigpsp/branch/release?svg=true
:target: https://ci.appveyor.com/project/Paebbels/poc/branch/release
:alt: Build status by AppVeyor
- .. image:: https://badges.gitter.im/ghdl/ghdl1.svg
- :target: https://gitter.im/ghdl/ghdl1
- :alt: Join
-
- .. raw:: html
-
- <br />
-
.. image:: https://img.shields.io/github/tag/tgingold/ghdl.svg?style=flat
:alt: Latest tag
.. image:: https://img.shields.io/github/release/tgingold/ghdl.svg?style=flat
@@ -64,7 +61,6 @@ labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam
et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata
sanctus est Lorem ipsum dolor sit amet
-
------------------------------------
.. |docdate| date:: %b %d, %Y - %H:%M
diff --git a/doc/intro/Contributing.rst b/doc/intro/Contributing.rst
index 3c9b50862..6919d4496 100644
--- a/doc/intro/Contributing.rst
+++ b/doc/intro/Contributing.rst
@@ -72,4 +72,9 @@ Again, rewriting part of it is a good way to improve it.
- Minimum-(non)-Working-Example (MWE)
- Pull Requests (PRs)
- Check Building -> GHDL -> Directory Structure]
- - 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
+ - Beware that some commit messages can `automatically close <https://help.github.com/articles/closing-issues-via-commit-messages/>`_ PRs]
+
+ There is a mailing list for any questions. You can subscribe via: https://mail.gna.org/listinfo/ghdl-discuss/
+ Please report bugs on https://github.com/tgingold/ghdl/issues
+
+ If you cannot compile, please report the gcc version, GNAT version and gcc source version. \ No newline at end of file
diff --git a/doc/intro/Copyrights.rst b/doc/intro/Copyrights.rst
index 3db6050c6..07c1780b3 100644
--- a/doc/intro/Copyrights.rst
+++ b/doc/intro/Copyrights.rst
@@ -48,4 +48,28 @@ points in distributing VHDL executable. Please, send a comment
- 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
+ - See `#280 <https://github.com/tgingold/ghdl/issues/280#issuecomment-279595802>`_
+
+ GHDL is copyright (c) 2002 - 2015 Tristan Gingold.
+
+ This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+
+ - Contributors to ghdl:
+ - Tristan Gingold (sole author of ghdl as a whole)
+ - Brian Drummond (gcc4.8.2 update, OSVVM port, some bugfixes)
+ - David Koontz (Mac OSX builds, LRM compliance work, bugfix analyses)
+ - Joris van Rantwijk (Debian packaging)
+ - Brian Davis (Windows Mcode builds)
+ - Adam Jensen (FreeBSD builds)
+ - Felix Bertram (VPI interface)
+
+with apologies to anyone who ought to be on this list but isn't.
+Thanks also to all those who have reported bugs and support issues,
+and often patches and testcases to either:
+https://gna.org/bugs/?group=ghdl
+or
+https://sourceforge.net/p/ghdl-updates/tickets/ \ No newline at end of file
diff --git a/doc/oldmds/BUILD.txt b/doc/oldmds/BUILD.txt
deleted file mode 100644
index 27029b757..000000000
--- a/doc/oldmds/BUILD.txt
+++ /dev/null
@@ -1,140 +0,0 @@
-Build GHDL (Long instructions)
-******************************
-
-GHDL supports many backend (code generator), so you first must choose
-the backend you want to use. There are currently 3 supported backends:
-
-* gcc
-* mcode (this is an internal code generator for x86_64 and i386)
-* llvm (experimental)
-
-Here is a short comparaison:
-
-* gcc:
-+ generated code is faster (particularly with -O or -O2)
-+ generated code can be debugged (with -g)
-+ the output is an executable
-+ ported to many platforms (x86, x86_64, powerpc, sparc)
-- analyze can takes time (particularly for big units)
-- build is more complex
-
-* mcode
-+ very easy to build
-- but x86_64/i386 only
-+ very quick analysis time
-+ can analyze very big designs
-- simulation is slower
-- no executable created
-
-* llvm
-+ same advantages of gcc (good generated code, debuggable)
-+ easier to build than gcc
-
-As GHDL is written in Ada, you need to use the GNU Ada compiler (GNAT).
-I recommend to use GNAT GPL from http://libre.adacore.com (free).
-GHDL was tested with GNAT GPL 2014. Any later version should work.
-The only other dependency is zlib (On ubuntu/debian, install zlib1g-dev).
-
-On UNIX and MinGW systems, you also need standard utilities like sh,
-cmp or make. On MSYS2 packages msys/diffutils and msys/make must be
-installed.
-
-In these instructions, the configure script is executed in the source
-directory; but you can execute in a different directory too, like
-this:
-$ mkdir ghdl-objs
-$ cd ghdl-objs
-$ ../path/to/ghdl/configure ...
-
-Building with mcode backend
-***************************
-
-This is as simple as:
-$ ./configure --prefix=PREFIX
- where PREFIX is the directory for installation
-$ make
- This builds the ghdl_mcode executable, which can be used as is.
-$ make install
- To install within PREFIX
-
-Building with the gcc backend
-*****************************
-
-You need to download and untar the sources of
-gcc version 4.9.x, 5.x, 6.x or 7.x
-
-First configure ghdl, specify gcc source dir and prefix.
-(replace /usr/local by your prefix directory):
-$ ./configure --with-gcc=/path/to/gcc/source/dir --prefix=/usr/local
-
-Then invoke make to copy ghdl sources in the source dir:
-$ make copy-sources
-
-There are some dependencies for building gcc (gmp, mpfr and mpc). If you have
-not them installed on your system, you can either build them manually or use
-the 'download_prerequisite' script provided in gcc source tree (recommended).
-
-$ cd /path/to/gcc/source/dir
-$ ./contrib/download_prerequisites
-
-Then configure gcc. The list of --disable configure options could be
-adjusted for your needs. GHDL don't require all these optional
-libraries and disabling them speed-up the build. Note the prefix
-directory must be the same as the one used to configure ghdl.
-If you have manually built gmp/mpfr/mpc (without using the script
-in contrib) and if you have installed them in a non-standard
-directory, you may need to add --with-gmp=GMP_INSTALL_DIR.
-If your system gcc was configured with --enable-default-pie (check if
-that option appears in the output of gcc -v), you should also add it.
-
-$ mkdir gcc-objs; cd gcc-objs
-$ ../gcc-4.9.3/configure --prefix=/usr/local --enable-languages=c,vhdl \
- --disable-bootstrap --disable-lto --disable-multilib \
- --disable-libssp --disable-libgomp --disable-libquadmath
-$ make -j2
-
-Install gcc:
-$ make install
-or if you don't want to install makeinfo:
-$ make install MAKEINFO=true
-
-Build and install vhdl libraries:
-$ cd /path/to/ghdl/source/dir
-$ make ghdllib
-$ make install
-
-Building with the llvm backend
-******************************
-
-You need to build and install llvm. The supported versions are 3.5
-till 5.x, but only debugging is only supported with llvm 3.5
-(Usually llvm also depends on libedit).
-
-First configure ghdl with '--with-llvm-config'
-$ ./configure --with-llvm-config
-
-If llvm-config is not in your path, you can specify it:
-$ ./configure --with-llvm-config=LLVM_INSTALL/bin/llvm-config
-
-If you want to have stack backtraces on errors (like assert failure or
-index of out bounds), you need to configure and build libbacktrace from gcc
-(you don't need to configure gcc), and add to configure:
- --with-backtrace-lib=/path-to-gcc-build/libbacktrace/.libs/libbacktrace.a
-
-Then build with 'make' and install with 'make install'.
-
-Notes for developpers
-*********************
-
-Developping with the gcc backend:
-Once gcc (with ghdl) has been built once, it is possible to work on ghdl
-sources tree without copying them in gcc tree. Commands are:
-$ make ghdl1-gcc # To build the compiler
-$ make ghdl_gcc # To build the driver
-$ make libs.vhdl.local_gcc # To compile the vhdl libraries
-$ make grt-all # To build the ghdl runtime
-
-In src/ortho/gcc, create a Makefile.conf file that sets the following
-variables:
-AGCC_GCCSRC_DIR=/path/to/gcc/sources
-AGCC_GCCOBJ_DIR=/path/to/gcc/build
diff --git a/doc/oldmds/gcc/INSTALL b/doc/oldmds/gcc/INSTALL
deleted file mode 100644
index b341317b5..000000000
--- a/doc/oldmds/gcc/INSTALL
+++ /dev/null
@@ -1,21 +0,0 @@
-Install file for the binary distribution of GHDL.
-
-GHDL is Copyright 2002 - 2015 Tristan Gingold.
-GHDL is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
-
-The binary are installed in /usr/local directory. You cannot change this
-default location, unless you set links.
-
-You must be root to install this distribution.
-
-To install ghdl:
-$ su
-# tar -C / -jxvf @TARFILE@.tar.bz2
-
-Note: you must also have a C compiler and zlib installed.
-
-Tristan Gingold.
-
diff --git a/doc/oldmds/gcc/README b/doc/oldmds/gcc/README
deleted file mode 100644
index c58e0f923..000000000
--- a/doc/oldmds/gcc/README
+++ /dev/null
@@ -1,51 +0,0 @@
-This is the README from the source distribution of GHDL.
-
-To get the binary distribution or more information, go to:
- https://github.com/tgingold/ghdl
-
-Copyright:
-**********
-GHDL is copyright (c) 2002 - 2015 Tristan Gingold.
-See the GHDL manual for more details.
-
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 59 Temple Place - Suite 330,
-Boston, MA 02111-1307, USA.
-
-
-Building GHDL from sources:
-***************************
-
-See BUILD.txt
-
-Please report bugs and issues on https://github.com/tgingold/ghdl/issues
-
-If you cannot compile, please report the gcc version, GNAT version and gcc
-source version.
-
-* Note for ppc64 (and AIX ?) platform:
-The object file format contains an identifier for the source language. Because
-gcc doesn't know about the VHDL, gcc crashes very early. This could be fixed
-with a very simple change in gcc/config/rs6000/rs6000.c,
-function rs6000_output_function_epilogue (as of gcc 4.8):
- else if (! strcmp (language_string, "GNU Objective-C"))
- i = 14;
- else
-- gcc_unreachable ();
-+ i = 0;
- fprintf (file, "%d,", i);
-
- /* 8 single bit fields: global linkage (not set for C extern linkage,
-
-Tristan Gingold.
diff --git a/doc/oldmds/mcode-README b/doc/oldmds/mcode-README
deleted file mode 100644
index 1e591b0b5..000000000
--- a/doc/oldmds/mcode-README
+++ /dev/null
@@ -1,47 +0,0 @@
-This is the README from the source distribution of GHDL.
-
-To get the binary distribution or more information, go to http://ghdl.free.fr
-
-Copyright:
-**********
-GHDL is copyright (c) 2002, 2003, 2004, 2005 Tristan Gingold.
-See the GHDL manual for more details.
-
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 59 Temple Place - Suite 330,
-Boston, MA 02111-1307, USA.
-
-
-Building GHDL from sources for Windows:
-***************************************
-
-Note: this was tested with Windows XP SP2 familly edition.
-
-Note: If you want to create the installer, GHDL should be built on a
-FAT partition. NSIS rounds files date to be FAT compliant (seconds are always
-even) and because GHDL stores dates, the files date must not be modified.
-
-Required:
-* the Ada95 GNAT compiler (GNAT GPL 2005 is known to work).
-* NSIS to create the installer.
-
-Unzip,
-edit winbuild to use correct path for makensis,
-run winbuild.
-
-The installer is in the windows directory.
-
-Send bugs and comments on https://github.com/tgingold/ghdl
-
-Tristan Gingold.
diff --git a/doc/oldmds/STYLE b/doc/references/CodingStyle.rst
index c7acb2756..76d33b5ca 100644
--- a/doc/oldmds/STYLE
+++ b/doc/references/CodingStyle.rst
@@ -1,5 +1,7 @@
-GHDL coding style
-*****************
+.. _REF:Style:
+
+Coding style
+#################
Ada subset: use only a simple (VHDL like) subset of Ada: no tasking, no
controlled types... VHDL users should easily understand that subset.
@@ -86,5 +88,4 @@ Do not initialize variables, constants must be declared before variables:
Sub : Iir;
begin
If the initialization expression has a side effect (such as allocation), do
-not use a constant.
-
+not use a constant. \ No newline at end of file
diff --git a/doc/references/CondigStyle.rst b/doc/references/CondigStyle.rst
deleted file mode 100644
index 51e236ee8..000000000
--- a/doc/references/CondigStyle.rst
+++ /dev/null
@@ -1,6 +0,0 @@
-.. _REF:Style:
-
-Coding style
-#################
-
-- `./doc/oldmds/gcc/STYLE <https://github.com/tgingold/ghdl/blob/master/doc/oldmds/STYLE>`_ \ No newline at end of file
diff --git a/doc/using/InvokingGHDL.rst b/doc/using/InvokingGHDL.rst
index d4bcda438..bf901bccc 100644
--- a/doc/using/InvokingGHDL.rst
+++ b/doc/using/InvokingGHDL.rst
@@ -1,4 +1,5 @@
.. _USING:Invoking:
+.. program:: ghdl
*************
Invoking GHDL