Skip to content

Commit

Permalink
Apply suggestions
Browse files Browse the repository at this point in the history
Signed-off-by: tempate <danieldiaz@eprosima.com>
  • Loading branch information
Tempate committed Jun 13, 2024
1 parent a9c882c commit 1712979
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,9 @@ class McapHandler : public ddspipe::participants::ISchemaHandler
*
* @param config: Structure encapsulating all configuration options.
* @param payload_pool: Owner of every payload contained in received messages.
* @param file_tracker: File tracker to be used to create and manage MCAP files.
* @param init_state: Initial instance state (RUNNING/PAUSED/STOPPED).
* @param on_disk_full_lambda: Lambda to be executed when the disk is full.
*/
DDSRECORDER_PARTICIPANTS_DllAPI
McapHandler(
Expand Down
1 change: 1 addition & 0 deletions docs/rst/recording/remote_control/remote_control.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ The following is the state diagram of the |ddsrecorder| application with all the
.. figure:: /rst/figures/recorder_state_diagram.png
:align: center

.. _recorder_remote_controller_data_types:

DDS Controller Data Types
=========================
Expand Down
2 changes: 1 addition & 1 deletion docs/rst/recording/usage/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ Enabling ``file-rotation`` allows the |ddsrecorder| to overwrite old files to fr

.. note::

To keep the |ddsrecorder| from overwriting previous output files, users can set ``{avoid_overwriting_output: true}`` as the argument of the ``stop`` signal.
To keep the |ddsrecorder| from overwriting previous output files, users can set ``{"avoid_overwriting_output": true}`` as the argument (``"args"``) of the ``stop`` command (see :ref:`Control Commands <recorder_remote_controller_data_types>`).
If set, the |ddsrecorder| will not overwrite its output files, at the cost of possibly exceeding the ``max-size``.

.. note::
Expand Down

0 comments on commit 1712979

Please sign in to comment.