Skip to content

Commit 1868638

Browse files
Documentation for fastdds shm clean --force (#1012)
Signed-off-by: cferreiragonz <carlosferreira@eprosima.com>
1 parent 7874384 commit 1868638

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

docs/fastddscli/cli/cli.rst

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -343,6 +343,10 @@ Zombie files are memory blocks that were reserved by shared memory and are no lo
343343
memory resources.
344344
This tool finds and frees those memory allocations.
345345

346+
It is also possible to clean :ref:`Data Sharing<datasharing-delivery>` segments when the ``--force`` option is used.
347+
However, this option should be used with caution, as it will remove all Data Sharing segments, including the ones
348+
that are being used by active applications.
349+
346350
.. code-block:: bash
347351
348352
fastdds shm [<shm-command>]
@@ -356,8 +360,15 @@ This tool finds and frees those memory allocations.
356360
+--------------------------+-------------------------------------------------------------------------------------------+
357361
| Option | Description |
358362
+==========================+===========================================================================================+
359-
| ``-h -help`` | Produce help message. |
363+
| ``-h --help`` | Produce help message. |
360364
+--------------------------+-------------------------------------------------------------------------------------------+
365+
| ``-f --force`` | Force the deletion of data sharing segments. |
366+
+--------------------------+-------------------------------------------------------------------------------------------+
367+
368+
.. warning::
369+
Running this command with the ``--force`` option will remove all Data Sharing segments, including the ones that
370+
are being used by active applications. Use this option only when there are no running Fast DDS applications,
371+
as it might raise errors if the segments are still in use.
361372

362373
.. _cli_xml:
363374

0 commit comments

Comments
 (0)