Skip to content

Commit

Permalink
Add v0.2.0 release notes (#44)
Browse files Browse the repository at this point in the history
* Add v0.2.0 release notes

Signed-off-by: Raul Sanchez-Mateos <[email protected]>

* Add missing include in docs

Signed-off-by: Raul Sanchez-Mateos <[email protected]>

* Fix spellcheck

Signed-off-by: Raul Sanchez-Mateos <[email protected]>

* Add release fixes to release notes

Signed-off-by: Raul Sanchez-Mateos <[email protected]>

---------

Signed-off-by: Raul Sanchez-Mateos <[email protected]>
  • Loading branch information
rsanchez15 authored Jun 28, 2023
1 parent 9cef5c7 commit f8446f2
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 37 deletions.
5 changes: 0 additions & 5 deletions docs/rst/notes/forthcoming_version.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,3 @@
Forthcoming Version
###################

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

* Support :ref:`Interface Whitelisting <user_manual_configuration_dds__interface_whitelist>`.
* Support :ref:`Custom Transport Descriptors <user_manual_configuration_dds_custom_transport_descriptors>` (UDP or Shared Memory only).
* Support :ref:`Ignore Participant Flags <user_manual_configuration_dds_ignore_participant_flags>`.
54 changes: 22 additions & 32 deletions docs/rst/notes/notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,48 +2,38 @@

.. _notes:

#####
Notes
#####

.. TODO uncomment when there are forthcoming notes
.. include:: forthcoming_version.rst

Version v0.1.0
==============

This is the first release of |espy|.

This release includes several **features** regarding the introspection of DDS data, configuration and user interaction.

This release includes the following **User Interface features**:

* :ref:`Application executable arguments <user_manual_user_interface_application_arguments>`.
* :ref:`Interactive application <user_manual_user_interface_interactive_app>`.
* :ref:`One-shot application <user_manual_user_interface_one_shot>`.
.. .. include:: forthcoming_version.rst
##############
Version v0.2.0
##############

This release includes the following **Configuration features**:
This release includes the following **Configuration Features**:

* Support :term:`YAML` :ref:`configuration file <user_manual_configuration>`.
* Support for allow and block topic filters at execution time and in run-time.
* Support :ref:`DDS configurations <user_manual_configuration_dds>`.
* Support :ref:`Advanced configurations <user_manual_configuration_specs>`.
* Support :ref:`Interface Whitelisting <user_manual_configuration_dds__interface_whitelist>`.
* Support :ref:`Custom Transport Descriptors <user_manual_configuration_dds_custom_transport_descriptors>` (UDP or Shared Memory only).
* Support :ref:`Ignore Participant Flags <user_manual_configuration_dds_ignore_participant_flags>`.

This release includes the following **Internal Changes** and **Bugfixes**:

This release includes the following **Introspection features**:
* Print only active participants when using verbose mode in ``participants`` command.
* Fix C++ *namespace* ambiguities in yaml configuration.
* Change default log-filter to only show warning coming from DDS Spy source code.
* Filter out topics associated to services (RPC).
* Parameterize simulated endpoints.

* Get data of :term:`Domain Participants <DomainParticipant>`.
* Get data of :term:`DataReaders <DataReader>` and :term:`DataWriters <DataWriter>`.
* Get data of :term:`Topics <Topic>`.
* Print real-time DDS user data in human-readable format.
This release includes the following **Documentation Updates**:

* Update introduction section in README file.

This release includes the following **Documentation features**:
This release includes the following change in the **Continuous Integration** process:

* This same documentation.
* Update CI to use `eProsima CI <https://github.com/eProsima/eProsima-CI>`__.


This release includes the following **Installation features**:
#################
Previous Versions
#################

* *Dockerfile* to build an image of the application ``Fast-DDS-Spy/docker``.
.. include:: ./previous_versions/v0.1.0.rst
38 changes: 38 additions & 0 deletions docs/rst/notes/previous_versions/v0.1.0.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
Version v0.1.0
==============

This is the first release of *eProsima Fast DDS Spy*.

This release includes several **features** regarding the introspection of DDS data, configuration and user interaction.

This release includes the following **User Interface features**:

* :ref:`Application executable arguments <user_manual_user_interface_application_arguments>`.
* :ref:`Interactive application <user_manual_user_interface_interactive_app>`.
* :ref:`One-shot application <user_manual_user_interface_one_shot>`.


This release includes the following **Configuration features**:

* Support :term:`YAML` :ref:`configuration file <user_manual_configuration>`.
* Support for allow and block topic filters at execution time and in run-time.
* Support :ref:`DDS configurations <user_manual_configuration_dds>`.
* Support :ref:`Advanced configurations <user_manual_configuration_specs>`.


This release includes the following **Introspection features**:

* Get data of :term:`Domain Participants <DomainParticipant>`.
* Get data of :term:`DataReaders <DataReader>` and :term:`DataWriters <DataWriter>`.
* Get data of :term:`Topics <Topic>`.
* Print real-time DDS user data in human-readable format.


This release includes the following **Documentation features**:

* This same documentation.


This release includes the following **Installation features**:

* *Dockerfile* to build an image of the application ``Fast-DDS-Spy/docker``.
1 change: 1 addition & 0 deletions docs/rst/spelling_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Asio
blocklist
Chocolatey
CMake
colcon
Colcon
cpp
dataflow
Expand Down

0 comments on commit f8446f2

Please sign in to comment.