change CHANGELOG from md to rst

Signed-off-by: Federico Vaga <federico.vaga@cern.ch>

change CHANGELOG from md to rst
Signed-off-by: Federico Vaga <federico.vaga@cern.ch>
0156922b · Federico Vaga · ff7945bc · 0156922b
Commit 0156922b authored Oct 14, 2019 by Federico Vaga
Hide whitespace changes
Inline Side-by-side

Showing with 109 additions and 0 deletions

CHANGELOG.rst CHANGELOG.rst +109 -0

No files found.
--- a/CHANGELOG
+++ b/CHANGELOG
-# Change Log
-## [4.0.2] - 2019-10-14
-### Changed
+==========
+Change Log
+==========
+
+[4.0.2] - 2019-10-14
+====================
+Changed
+-------
 - [sw] build driver on Linux v5.0 or greater
 - [sw] driver sysfs files permission are g+w
-### Fixed
+Fixed
+-----
 - [sw] string overflow control
 - [sw] ``trtl_msg_poll`` input validation
-## [4.0.1] - 2019-09-13
-### Software
-#### Fixed
- File Descriptor closed correctly so that the same process can do
+
+[4.0.1] - 2019-09-13
+====================
+Fixed
+-----
+- [sw] File Descriptor closed correctly so that the same process can do
  ``trtl_open()`` and ``trtl_close()`` multiple times
-## [4.0.0] - 2019-05-14
-### Documentation
-#### Changed
- moved to sphinx and ReST
- merged HDL and software
- improved with examples
- doxygen and wbgen2 integration
-#### Added
- Tools section
- Demo section
- Glossary section
-### Gateware
-#### Changed
- soft-CPU is now uRV
- each core has a set of dedicated HMQ and RMQ
-#### Added
- uRV debug interface
- notification interrupts from firmwares
- new test benches
-### Software
-#### Changed
- synchronous messages redesigned
- HMQ API reflects gateware changes
- firmware library and framework improvements
- re-design Python wrapper a bit
-#### Added
- driver auto-configuration from configuration ROM
- GDB agent to debug firmware
- tool to generated empty projects
- tools to interact with firmware framework
-#### Removed
- Driver message filter
- LM32 support
- function to pause and start CPU execution
-### Demo
-#### Added
- new demo section
-### Tests
-#### Added
- new integration test section

-## [3.1.0] - 2018-03-09
-### Gateware
+[4.0.0] - 2019-05-14
+====================
+Changed
+-------
+- [gw] soft-CPU is now uRV
+- [gw] each core has a set of dedicated HMQ and RMQ
+- [doc] moved to sphinx and ReST
+- [doc] merged HDL and software
+- [doc] improved with examples
+- [doc] doxygen and wbgen2 integration
+- [sw] synchronous messages redesigned
+- [sw] HMQ API reflects gateware changes
+- [sw] firmware library and framework improvements
+- [sw] re-design Python wrapper a bit
+Added
+-----
+- [gw] uRV debug interface
+- [gw] notification interrupts from firmwares
+- [gw] new test benches
+- [doc] Tools section
+- [doc] Demo section
+- [doc] Glossary section
+- [sw] driver auto-configuration from configuration ROM
+- [sw] GDB agent to debug firmware
+- [sw] tool to generated empty projects
+- [sw] tools to interact with firmware framework
+- [demo] new demo section
+- [test] new integration test section
+Removed
+-------
+- [sw] Driver message filter
+- [sw] LM32 support
+- [sw] function to pause and start CPU execution
+
+[3.1.0] - 2018-03-09
+====================
 This release brings in the gateware from wr-node-core repository, such as it
 is being used in the released and deployed v1.0 version of masterFIP.
 The relevant commit is 96a7859 from git://ohwr.org/white-rabbit/wr-node-core.git.
 This is a "known to work" version of the gateware, still using the "node core" name.
 Following releases will switch to the "mock turtle" name.

-## [3.0.0] - 2017-09-14
-### Software
+[3.0.0] - 2017-09-14
+====================
 The realease of a new version has been necessary because I decided to remove
 the debug interface from the API. This interface has been problematic, and
 its original purpose has been neglected
-#### Added
- standard TTY interface to access the soft-CPU serial console output
-#### Removed
- debugfs interface to access the soft-CPU serial console output
- removed library functions to access the debugfs console output
- the ``mockturtle-messages`` tool is not able anymore to access the soft-CPU
-serial console output
-#### Fixed
- minor fixes
+Added
+-----
+- [sw] standard TTY interface to access the soft-CPU serial console output
+Removed
+-------
+- [sw] debugfs interface to access the soft-CPU serial console output
+- [sw] removed library functions to access the debugfs console output
+- [sw] the ``mockturtle-messages`` tool is not able anymore to access the
+  soft-CPU serial console output
+Fixed
+-----
+- [sw] minor fixes

-## [2.0] - 2016-06-08
-### Software
-#### Changed
- Project change name to Mock Turtle. this means renaming all files
-  functions, data structures, enumerates and variables to a new
+[2.0.0] - 2016-06-08
+====================
+Changed
+-------
+- [sw] Project change name to Mock Turtle. this means renaming all files
+  [sw] functions, data structures, enumerates and variables to a new
  convention
- port output real-time application to the real-time library
- improve kernel driver performance
-#### Added
- unittest
+- [sw] port output real-time application to the real-time library
+- [sw] improve kernel driver performance
+Added
+-----
+- [test] unittest

-## [1.1] - 2015-10-20
-### Software
-#### Changed
- minor changes in API behaviour on error
+[1.1.0] - 2015-10-20
+====================
+Changed
+-------
+- [sw] minor changes in API behaviour on error

-## [1.0] - 2015-09-17
-### Software
- first release White Rabbit Node Core
+[1.0.0] - 2015-09-17
+====================
+- [sw] first release White Rabbit Node Core

 [3.0.0] https://www.ohwr.org/projects/mock-turtle-sw/repository?rev=mock-turtle-3.0.0
 [2.0] https://www.ohwr.org/projects/mock-turtle-sw/repository?rev=mock-turtle-2.0