Skip to content

Commit

Permalink
Add forthcoming version to documentation (#144)
Browse files Browse the repository at this point in the history
* Refs #13792: Add forthcoming version to documentation

Signed-off-by: jparisu <[email protected]>

* Refs #13792: apply suggestsions

Signed-off-by: jparisu <[email protected]>
  • Loading branch information
jparisu authored Feb 8, 2022
1 parent d25c5ef commit f9ffa97
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@
:hidden:

/rst/notes/notes
/rst/notes/new_version


.. _index_appendix:
Expand Down
37 changes: 37 additions & 0 deletions docs/rst/notes/new_version.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
.. include:: ../exports/alias.include

.. _forthcoming_notes:

###################
Forthcoming Version
###################

Next release will include the following **Configuration features**:

* Support TLS configuration and communication.
* Support IPv6 communication via UDP, TCP and TLS.
* Support DNS by given Domain Name in configuration instead of an IP address.
* Support keyed topics.

Next release will include the following **User Interface features**:

* Allow to close the Router application gently with ``SIGTERM`` (``kill``) as with ``SIGINT`` (``^C``).

Next release will include the following **Continuous-Integration features**:

* Add communication tests for UDP, TCP and TLS WAN cases.
* Extend tool test with more complex configurations.
* Erase Flaky tests from CI required passing tests.
* Implement a new class to check that no warning or error logs are produced during test executions.
* Add gMock to test libraries.

Next release will fix the following **major bugs**:

* Fix GUID creation when explicit guid is provided.

Next release will fix the following **minor bugs**:

* Change ``YAML`` example configurations to ``YAML`` format (instead of ``JSON``) fixing
an issue when blank lines were missing at the end of the file.
* Normalize the error and process exit when failure.
* Fix documentation typos.
1 change: 1 addition & 0 deletions docs/rst/spelling_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ fastcdr
fastrtps
github
Gtest
gMock
guid
guid
IPv
Expand Down

0 comments on commit f9ffa97

Please sign in to comment.