From 9949ac25564f7c288abb323de485cdad9f6d0791 Mon Sep 17 00:00:00 2001 From: Lucia Echevarria Date: Thu, 4 Jan 2024 07:57:31 +0100 Subject: [PATCH 1/2] Update release notes in docs Signed-off-by: Lucia Echevarria --- docs/rst/notes/forthcoming_version.rst | 38 --------- docs/rst/notes/notes.rst | 85 ++++++--------------- docs/rst/notes/previous_versions/v0.2.0.rst | 71 +++++++++++++++++ 3 files changed, 94 insertions(+), 100 deletions(-) delete mode 100644 docs/rst/notes/forthcoming_version.rst create mode 100644 docs/rst/notes/previous_versions/v0.2.0.rst diff --git a/docs/rst/notes/forthcoming_version.rst b/docs/rst/notes/forthcoming_version.rst deleted file mode 100644 index d8916290e..000000000 --- a/docs/rst/notes/forthcoming_version.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. add orphan tag when new info added to this file - -.. :orphan: - -################### -Forthcoming Version -################### - -This release will include the following **Recording features**: - -* New DDS Recorder suspended (active stopped) state (see :ref:`remote controller ` for more details). - -Next release will include the following **DDS Recorder & Replay internal adjustments**: - -* Store *DDS Record & Replay* version in metadata record of the generated MCAP files. -* Move dynamic types storage from metadata to attachments MCAP section. -* Set `app_id` and `app_metadata` attributes on *DDS Record & Replay* participants. -* Store schemas in OMG IDL and ROS 2 msg format. - -.. warning:: - - Types recorded with previous versions of *DDS Record & Replay* will no longer be "replayable" after this update. - -Next release will include the following **DDS Recorder tool configuration features**: - -* Support :ref:`Compression Settings `. -* Allow disabling the storage of received types (see :ref:`Record Types `). -* New configuration options (``timestamp-format`` and ``local-timestamp``) available for :ref:`output file ` settings. -* New configuration option (``topics``) to configure the :ref:`Manual Topics `. -* Rename ``max-reception-rate`` to ``max-rx-rate``. -* Record data in either ROS 2 format or the raw DDS format (see :ref:`Topic Type Format `). - -Next release will include the following **DDS Replayer tool configuration features**: - -* New configuration option (``topics``) to configure the :ref:`Manual Topics `. -* New configuration option (``max-tx-rate``) to configure the :ref:`Max transmission rate `. -* Remove the support for `Built-in Topics `_. -* Read data in either ROS 2 format or the raw DDS format. diff --git a/docs/rst/notes/notes.rst b/docs/rst/notes/notes.rst index 889d5af96..0ff17bc45 100644 --- a/docs/rst/notes/notes.rst +++ b/docs/rst/notes/notes.rst @@ -2,83 +2,44 @@ .. _notes: -.. TODO uncomment when there are forthcoming notes -.. include:: forthcoming_version.rst - ############## -Version v0.2.0 +Version v0.3.0 ############## -This release includes *DDS Replay tool*, supporting the following **Replay features**: - -* Supports setting :ref:`begin ` and :ref:`end ` times (``begin-time`` / ``end-time``). -* Supports setting a replay :ref:`start ` time (``start-replay-time``). -* Supports playing stored data at a specific playback :ref:`rate ` (``rate``). -* Supports sending dynamic types stored in input MCAP file. - -This release includes the following **User Interface features**: - -* :ref:`Replay Service Command-Line Parameters `. - -This release includes the following (*DDS Replay tool*) **Configuration features**: - -* Support YAML :ref:`configuration file `. -* Support for allow and block topic filters at execution time and in run-time. -* Support configuration related to DDS communication. -* Support configuration of playback settings. -* Support configuration of the internal operation of the DDS Replayer. -* Support enabling/disabling dynamic types dispatch (see :ref:`Only With Type `). -* Support :ref:`Interface Whitelisting `. -* Support :ref:`Custom Transport Descriptors ` (UDP or Shared Memory only). -* Support :ref:`Ignore Participant Flags `. - This release includes the following **Recording features**: -* Supports recording messages with unknown (dynamic) data type, and to only record data whose type is known (see :ref:`Only With Type `). +* New DDS Recorder suspended (active stopped) state (see :ref:`remote controller ` for more details). + +This release includes the following **DDS Recorder & Replay internal adjustments**: -This release includes the following (*DDS Recorder tool*) **Configuration features**: +* Stores *DDS Record & Replay* version in metadata record of the generated MCAP files. +* Moves dynamic types storage from metadata to attachments MCAP section. +* Sets `app_id` and `app_metadata` attributes on *DDS Record & Replay* participants. +* Stores schemas in OMG IDL and ROS 2 msg format. -* Support record only data whose (dynamic) type is known: ``only-with-type: true`` (see :ref:`Only With Type `). -* Support :ref:`Interface Whitelisting `. -* Support :ref:`Custom Transport Descriptors ` (UDP or Shared Memory only). -* Support :ref:`Ignore Participant Flags `. +.. warning:: -This release includes the following **Documentation features**: + Types recorded with previous versions of *DDS Record & Replay* is no longer "replayable" after this update. -* Updated documentation with Replay service configuration and usage instructions. +This release includes the following **DDS Recorder tool configuration features**: -This release includes the following **Dependencies Update**: +* Supports :ref:`Compression Settings `. +* Allows disabling the storage of received types (see :ref:`Record Types `). +* New configuration options (``timestamp-format`` and ``local-timestamp``) available for :ref:`output file ` settings. +* New configuration option (``topics``) to configure the :ref:`Manual Topics `. +* Renames ``max-reception-rate`` to ``max-rx-rate``. +* Records data in either ROS 2 format or the raw DDS format (see :ref:`Topic Type Format `). -.. list-table:: - :header-rows: 1 +This release includes the following **DDS Replayer tool configuration features**: - * - - - Repository - - Old Version - - New Version - * - Foonathan Memory Vendor - - `eProsima/foonathan_memory_vendor `_ - - `v1.3.0 `_ - - `v1.3.1 `_ - * - Fast CDR - - `eProsima/Fast-CDR `_ - - `v1.0.27 `_ - - `v1.1.0 `_ - * - Fast DDS - - `eProsima/Fast-DDS `_ - - `v2.10.1 `_ - - `v2.11.0 `_ - * - Dev Utils - - `eProsima/dev-utils `_ - - `v0.3.0 `_ - - `v0.4.0 `_ - * - DDS Pipe - - `eProsima/DDS-Pipe `_ - - `v0.1.0 `_ - - `v0.2.0 `_ +* New configuration option (``topics``) to configure the :ref:`Manual Topics `. +* New configuration option (``max-tx-rate``) to configure the :ref:`Max transmission rate `. +* Removes the support for `Built-in Topics `_. +* Reads data in either ROS 2 format or the raw DDS format. ################# Previous Versions ################# +.. include:: previous_versions/v0.2.0.rst .. include:: previous_versions/v0.1.0.rst diff --git a/docs/rst/notes/previous_versions/v0.2.0.rst b/docs/rst/notes/previous_versions/v0.2.0.rst new file mode 100644 index 000000000..a8fb842b6 --- /dev/null +++ b/docs/rst/notes/previous_versions/v0.2.0.rst @@ -0,0 +1,71 @@ + +Version v0.2.0 +============== + +This release includes *DDS Replay tool*, supporting the following **Replay features**: + +* Supports setting :ref:`begin ` and :ref:`end ` times (``begin-time`` / ``end-time``). +* Supports setting a replay :ref:`start ` time (``start-replay-time``). +* Supports playing stored data at a specific playback :ref:`rate ` (``rate``). +* Supports sending dynamic types stored in input MCAP file. + +This release includes the following **User Interface features**: + +* :ref:`Replay Service Command-Line Parameters `. + +This release includes the following (*DDS Replay tool*) **Configuration features**: + +* Support YAML :ref:`configuration file `. +* Support for allow and block topic filters at execution time and in run-time. +* Support configuration related to DDS communication. +* Support configuration of playback settings. +* Support configuration of the internal operation of the DDS Replayer. +* Support enabling/disabling dynamic types dispatch (see :ref:`Only With Type `). +* Support :ref:`Interface Whitelisting `. +* Support :ref:`Custom Transport Descriptors ` (UDP or Shared Memory only). +* Support :ref:`Ignore Participant Flags `. + +This release includes the following **Recording features**: + +* Supports recording messages with unknown (dynamic) data type, and to only record data whose type is known (see :ref:`Only With Type `). + +This release includes the following (*DDS Recorder tool*) **Configuration features**: + +* Support record only data whose (dynamic) type is known: ``only-with-type: true`` (see :ref:`Only With Type `). +* Support :ref:`Interface Whitelisting `. +* Support :ref:`Custom Transport Descriptors ` (UDP or Shared Memory only). +* Support :ref:`Ignore Participant Flags `. + +This release includes the following **Documentation features**: + +* Updated documentation with Replay service configuration and usage instructions. + +This release includes the following **Dependencies Update**: + +.. list-table:: + :header-rows: 1 + + * - + - Repository + - Old Version + - New Version + * - Foonathan Memory Vendor + - `eProsima/foonathan_memory_vendor `_ + - `v1.3.0 `_ + - `v1.3.1 `_ + * - Fast CDR + - `eProsima/Fast-CDR `_ + - `v1.0.27 `_ + - `v1.1.0 `_ + * - Fast DDS + - `eProsima/Fast-DDS `_ + - `v2.10.1 `_ + - `v2.11.0 `_ + * - Dev Utils + - `eProsima/dev-utils `_ + - `v0.3.0 `_ + - `v0.4.0 `_ + * - DDS Pipe + - `eProsima/DDS-Pipe `_ + - `v0.1.0 `_ + - `v0.2.0 `_ From 5739a8db2a8314f2f62c0302968bb060c0dee5a0 Mon Sep 17 00:00:00 2001 From: Lucia Echevarria Date: Mon, 8 Jan 2024 11:27:17 +0100 Subject: [PATCH 2/2] Changes on release notes Signed-off-by: Lucia Echevarria --- docs/rst/notes/forthcoming_version.rst | 7 +++++++ docs/rst/notes/notes.rst | 23 +++++++++++++---------- 2 files changed, 20 insertions(+), 10 deletions(-) create mode 100644 docs/rst/notes/forthcoming_version.rst diff --git a/docs/rst/notes/forthcoming_version.rst b/docs/rst/notes/forthcoming_version.rst new file mode 100644 index 000000000..d3565025f --- /dev/null +++ b/docs/rst/notes/forthcoming_version.rst @@ -0,0 +1,7 @@ +.. add orphan tag when new info added to this file + +.. :orphan: + +################### +Forthcoming Version +################### diff --git a/docs/rst/notes/notes.rst b/docs/rst/notes/notes.rst index 0ff17bc45..d86f3f54b 100644 --- a/docs/rst/notes/notes.rst +++ b/docs/rst/notes/notes.rst @@ -2,6 +2,9 @@ .. _notes: +.. TODO uncomment when there are forthcoming notes +.. .. include:: forthcoming_version.rst + ############## Version v0.3.0 ############## @@ -12,10 +15,10 @@ This release includes the following **Recording features**: This release includes the following **DDS Recorder & Replay internal adjustments**: -* Stores *DDS Record & Replay* version in metadata record of the generated MCAP files. -* Moves dynamic types storage from metadata to attachments MCAP section. -* Sets `app_id` and `app_metadata` attributes on *DDS Record & Replay* participants. -* Stores schemas in OMG IDL and ROS 2 msg format. +* Store *DDS Record & Replay* version in metadata record of the generated MCAP files. +* Move dynamic types storage from metadata to attachments MCAP section. +* Set `app_id` and `app_metadata` attributes on *DDS Record & Replay* participants. +* Store schemas in OMG IDL and ROS 2 msg format. .. warning:: @@ -23,19 +26,19 @@ This release includes the following **DDS Recorder & Replay internal adjustments This release includes the following **DDS Recorder tool configuration features**: -* Supports :ref:`Compression Settings `. -* Allows disabling the storage of received types (see :ref:`Record Types `). +* Support :ref:`Compression Settings `. +* Allow disabling the storage of received types (see :ref:`Record Types `). * New configuration options (``timestamp-format`` and ``local-timestamp``) available for :ref:`output file ` settings. * New configuration option (``topics``) to configure the :ref:`Manual Topics `. -* Renames ``max-reception-rate`` to ``max-rx-rate``. -* Records data in either ROS 2 format or the raw DDS format (see :ref:`Topic Type Format `). +* Rename ``max-reception-rate`` to ``max-rx-rate``. +* Record data in either ROS 2 format or the raw DDS format (see :ref:`Topic Type Format `). This release includes the following **DDS Replayer tool configuration features**: * New configuration option (``topics``) to configure the :ref:`Manual Topics `. * New configuration option (``max-tx-rate``) to configure the :ref:`Max transmission rate `. -* Removes the support for `Built-in Topics `_. -* Reads data in either ROS 2 format or the raw DDS format. +* Remove the support for `Built-in Topics `_. +* Read data in either ROS 2 format or the raw DDS format. ################# Previous Versions