From 2cdc900c002f79f9edb267c57bc18bd8b6b4b90a Mon Sep 17 00:00:00 2001 From: Pablo Garrido Date: Tue, 26 Apr 2022 08:07:41 +0200 Subject: [PATCH] Fix typos (#73) Signed-off-by: Pablo Garrido --- docs/client.rst | 2 +- docs/optimization.rst | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/client.rst b/docs/client.rst index b7b6604..4cbd2a9 100644 --- a/docs/client.rst +++ b/docs/client.rst @@ -11,7 +11,7 @@ In *eProsima Micro XRCE-DDS*, a *Client* can communicate with the DDS Network as *Clients* can either publish and subscribe to data Topics in the DDS Global Data Space, or act as a client/service application following a request-reply pattern. -This section explains how the *Client-Agent* communication happens through streams that can be either best-effort or Reliable. +This section explains how the *Client-Agent* communication happens through streams that can be either best-effort or reliable. After this, it is explained how users can configure *Clients* applications and the communication with the *Agent* via sets of CMake flags (:code:`-D=`) that enable/disable profiles and/or allow customize the size of several parameters. diff --git a/docs/optimization.rst b/docs/optimization.rst index 89b0519..c19efb2 100644 --- a/docs/optimization.rst +++ b/docs/optimization.rst @@ -17,7 +17,7 @@ To add or remove profiles from the library, enable or disable them as CMake argu More information can be found at: :ref:`micro_xrce_dds_client_label`. .. important:: - + When compiling with *gcc*, it is highly recommended to compile it with the linker flag: ``-Wl,--gc-sections``. It will remove the code that the app doesn't use from the final executable. @@ -39,13 +39,13 @@ History of a reliable stream The history is used for recovering lost messages and for speeding up the communication. For output streams, a bigger history will allow writing and sending more messages without having to wait for confirmation. - However, if the history of an output stream is full (no messages confirmed by the *Agent* yet), + However, if the history of an output stream is full (no messages confirmed by the *Agent* yet), no more messages can be stored in the stream. For input streams, the history is used for recovering lost messages faster while reducing the bandwidth. If the connection is highly reliable and saving memory is a priority, a reduced history can be used. Stream size - In case of reliable communciation, this size is equal to :code:`MAX_MESSAGE_SIZE * HISTORY`. + In case of reliable communication, this size is equal to :code:`MAX_MESSAGE_SIZE * HISTORY`. In case of a best-effort stream, the size simply equals :code:`MAX_MESSAGE_SIZE`, as no history is made available in this case. The :code:`MAX_MESSAGE_SIZE` represents the maximum message size that can be sent without