Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[21861] Enable Datasharing segments clean from CLI #1012

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[21861] Enable Datasharing segments clean from CLI #1012

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion docs/fastddscli/cli/cli.rst
View file
Open in desktop
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