From 462d27734269b9f550a062b24bdf83c6327b3a51 Mon Sep 17 00:00:00 2001 From: cferreiragonz Date: Wed, 8 Jan 2025 12:42:36 +0100 Subject: [PATCH] Refs #21861: Docs for --force param Signed-off-by: cferreiragonz --- docs/fastddscli/cli/cli.rst | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/fastddscli/cli/cli.rst b/docs/fastddscli/cli/cli.rst index b9cf01c11..4b2a5445f 100644 --- a/docs/fastddscli/cli/cli.rst +++ b/docs/fastddscli/cli/cli.rst @@ -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` 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 [] @@ -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: