Skip to content

Commit

Permalink
Documentation for fastdds shm clean --force (#1012)
Browse files Browse the repository at this point in the history
Signed-off-by: cferreiragonz <[email protected]>
  • Loading branch information
cferreiragonz authored Jan 16, 2025
1 parent 7874384 commit 1868638
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion docs/fastddscli/cli/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -343,6 +343,10 @@ Zombie files are memory blocks that were reserved by shared memory and are no lo
memory resources.
This tool finds and frees those memory allocations.

It is also possible to clean :ref:`Data Sharing<datasharing-delivery>` segments when the ``--force`` option is used.
However, this option should be used with caution, as it will remove all Data Sharing segments, including the ones
that are being used by active applications.

.. code-block:: bash
fastdds shm [<shm-command>]
Expand All @@ -356,8 +360,15 @@ This tool finds and frees those memory allocations.
+--------------------------+-------------------------------------------------------------------------------------------+
| Option | Description |
+==========================+===========================================================================================+
| ``-h -help`` | Produce help message. |
| ``-h --help`` | Produce help message. |
+--------------------------+-------------------------------------------------------------------------------------------+
| ``-f --force`` | Force the deletion of data sharing segments. |
+--------------------------+-------------------------------------------------------------------------------------------+

.. warning::
Running this command with the ``--force`` option will remove all Data Sharing segments, including the ones that
are being used by active applications. Use this option only when there are no running Fast DDS applications,
as it might raise errors if the segments are still in use.

.. _cli_xml:

Expand Down

0 comments on commit 1868638

Please sign in to comment.