[1/3] doc: fix typo in ipc doc

Message ID c5b98a67c6f0b66b3ef0534dc1b9ed553d4d7340.1556883753.git.anatoly.burakov@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series [1/3] doc: fix typo in ipc doc |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/mellanox-Performance-Testing success Performance Testing PASS
ci/intel-Performance-Testing success Performance Testing PASS
ci/Intel-compilation success Compilation OK

Commit Message

Anatoly Burakov May 3, 2019, 11:50 a.m. UTC
  The word "syncrhonous" appears twice. Fix it.

Cc: stable@dpdk.org

Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
---
 doc/guides/prog_guide/multi_proc_support.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
  

Comments

Rami Rosen May 3, 2019, 7:03 p.m. UTC | #1
Anatoly Burakov ‏<anatoly.burakov@intel.com>:

> The word "syncrhonous" appears twice. Fix it.
>
> Cc: stable@dpdk.org
>
> Signed-off-by: Anatoly Burakov <anatoly.burakov@intel.com>
> ---
>

Reviewed-by: Rami Rosen <ramirose@gmail.com>
  
Thomas Monjalon May 9, 2019, 2:41 p.m. UTC | #2
03/05/2019 13:50, Anatoly Burakov:
> The word "syncrhonous" appears twice. Fix it.
[...]
> --- a/doc/guides/prog_guide/multi_proc_support.rst
> +++ b/doc/guides/prog_guide/multi_proc_support.rst
> -For synchronous synchronous requests, the ``rte_mp_reply`` descriptor must also
> -be created. This is where the responses will be stored. The list of fields that
> -will be populated by IPC are as follows:
> +For synchronous requests, the ``rte_mp_reply`` descriptor must also be created.
> +This is where the responses will be stored. The list of fields that will be
> +populated by IPC are as follows:

For this reason, it is better to return to new line at the end of a sentence,
or after a comma. So the future patch will change only one line.
I will split this one.
  
John McNamara May 9, 2019, 3:25 p.m. UTC | #3
> -----Original Message-----
> From: Burakov, Anatoly
> Sent: Friday, May 3, 2019 12:51 PM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Kovacevic, Marko
> <marko.kovacevic@intel.com>; stable@dpdk.org
> Subject: [PATCH 1/3] doc: fix typo in ipc doc
> 
> The word "syncrhonous" appears twice. Fix it.

Acked-by: John McNamara <john.mcnamara@intel.com>
  
Thomas Monjalon May 9, 2019, 3:55 p.m. UTC | #4
09/05/2019 17:25, Mcnamara, John:
> From: Burakov, Anatoly
> > The word "syncrhonous" appears twice. Fix it.

"synchronous" ;)

Fixes: e22266669e86 ("doc: add IPC guide")

> Acked-by: John McNamara <john.mcnamara@intel.com>

Series applied, thanks
  

Patch

diff --git a/doc/guides/prog_guide/multi_proc_support.rst b/doc/guides/prog_guide/multi_proc_support.rst
index 6196d3f21..1e78a1f02 100644
--- a/doc/guides/prog_guide/multi_proc_support.rst
+++ b/doc/guides/prog_guide/multi_proc_support.rst
@@ -263,9 +263,9 @@  To send a request, a message descriptor ``rte_mp_msg`` must be populated.
 Additionally, a ``timespec`` value must be specified as a timeout, after which
 IPC will stop waiting and return.
 
-For synchronous synchronous requests, the ``rte_mp_reply`` descriptor must also
-be created. This is where the responses will be stored. The list of fields that
-will be populated by IPC are as follows:
+For synchronous requests, the ``rte_mp_reply`` descriptor must also be created.
+This is where the responses will be stored. The list of fields that will be
+populated by IPC are as follows:
 
 * ``nb_sent`` - number indicating how many requests were sent (i.e. how many
   peer processes were active at the time of the request).