patches for DPDK stable branches
 help / color / mirror / Atom feed
From: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
To: honnappa.nagarahalli@arm.com, david.marchand@redhat.com,
	konstantin.ananyev@intel.com
Cc: dev@dpdk.org, ruifeng.wang@arm.com, stable@dpdk.org, nd@arm.com
Subject: [dpdk-stable] [PATCH v2 1/7] doc/rcu: fix typos
Date: Tue,  8 Oct 2019 16:12:14 -0500	[thread overview]
Message-ID: <20191008211220.31586-2-honnappa.nagarahalli@arm.com> (raw)
In-Reply-To: <20191008211220.31586-1-honnappa.nagarahalli@arm.com>

Fix typos.

Fixes: 64994b56cfd7 ("rcu: add RCU library supporting QSBR mechanism")
Cc: stable@dpdk.org

Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
Reviewed-by: Ruifeng Wang <ruifeng.wang@arm.com>
Reviewed-by: Gavin Hu <gavin.hu@arm.com>
---
 doc/guides/prog_guide/rcu_lib.rst | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

diff --git a/doc/guides/prog_guide/rcu_lib.rst b/doc/guides/prog_guide/rcu_lib.rst
index 8fe5b1f73..c019dfca8 100644
--- a/doc/guides/prog_guide/rcu_lib.rst
+++ b/doc/guides/prog_guide/rcu_lib.rst
@@ -37,8 +37,8 @@ What is Quiescent State
 -----------------------
 
 Quiescent State can be defined as "any point in the thread execution where the
-thread does not hold a reference to shared memory". It is up to the application
-to determine its quiescent state.
+thread does not hold a reference to shared memory". It is the responsibility of
+the application to determine its quiescent state.
 
 Let us consider the following diagram:
 
@@ -76,7 +76,7 @@ Factors affecting the RCU mechanism
 
 It is important to make sure that this library keeps the overhead of
 identifying the end of grace period and subsequent freeing of memory,
-to a minimum. The following explains how grace period and critical
+to a minimum. The following paras explain how grace period and critical
 section affect this overhead.
 
 The writer has to poll the readers to identify the end of grace period.
@@ -91,14 +91,14 @@ critical sections smaller requires additional CPU cycles (due to additional
 reporting) in the readers.
 
 Hence, we need the characteristics of a small grace period and large critical
-section. This library addresses this by allowing the writer to do
-other work without having to block until the readers report their quiescent
-state.
+section. This library addresses these characteristics by allowing the writer
+to do other work without having to block until the readers report their
+quiescent state.
 
 RCU in DPDK
 -----------
 
-For DPDK applications, the start and end of a ``while(1)`` loop (where no
+For DPDK applications, the beginning and end of a ``while(1)`` loop (where no
 references to shared data structures are kept) act as perfect quiescent
 states. This will combine all the shared data structure accesses into a
 single, large critical section which helps keep the overhead on the
@@ -106,11 +106,11 @@ reader side to a minimum.
 
 DPDK supports a pipeline model of packet processing and service cores.
 In these use cases, a given data structure may not be used by all the
-workers in the application. The writer does not have to wait for all
-the workers to report their quiescent state. To provide the required
-flexibility, this library has a concept of a QS variable. The application
-can create one QS variable per data structure to help it track the
-end of grace period for each data structure. This helps keep the grace
+workers in the application. The writer has to wait only for the workers that
+use the data structure to report their quiescent state. To provide the required
+flexibility, this library has a concept of a QS variable. If required, the
+application can create one QS variable per data structure to help it track the
+end of grace period for each data structure. This helps keep the length of grace
 period to a minimum.
 
 How to use this library
-- 
2.17.1


  reply	other threads:[~2019-10-08 21:12 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-10-08 21:12 [dpdk-stable] [PATCH 0/7] typo, doc, simple fixes and some optimizations Honnappa Nagarahalli
2019-10-08 21:12 ` Honnappa Nagarahalli [this message]
2019-10-08 21:12 ` [dpdk-stable] [PATCH v2 2/7] doc/rcu: correct the limitation on number of threads Honnappa Nagarahalli
2019-10-08 21:12 ` [dpdk-stable] [PATCH v2 3/7] doc/rcu: add information about storing token and resource Honnappa Nagarahalli
2019-10-08 21:12 ` [dpdk-stable] [PATCH v2 4/7] test/rcu: use size_t instead of int Honnappa Nagarahalli
2019-10-21 19:19   ` David Marchand
2019-10-08 21:12 ` [dpdk-stable] [PATCH v2 5/7] test/rcu: use correct nomenclature while printing results Honnappa Nagarahalli
2019-10-08 21:12 ` [dpdk-stable] [PATCH v2 6/7] lib/rcu: add least acknowledged token optimization Honnappa Nagarahalli
2019-10-08 21:12 ` [dpdk-stable] [PATCH v2 7/7] lib/rcu: update QS only when there are updates from writer Honnappa Nagarahalli
2019-10-18  9:57 ` [dpdk-stable] [PATCH] rcu: fix reference to offline function David Marchand
2019-10-18 13:58   ` Honnappa Nagarahalli
2019-10-21 19:25     ` David Marchand
2019-10-21 19:19 ` [dpdk-stable] [PATCH 0/7] typo, doc, simple fixes and some optimizations David Marchand
2019-10-21 19:39   ` Honnappa Nagarahalli

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20191008211220.31586-2-honnappa.nagarahalli@arm.com \
    --to=honnappa.nagarahalli@arm.com \
    --cc=david.marchand@redhat.com \
    --cc=dev@dpdk.org \
    --cc=konstantin.ananyev@intel.com \
    --cc=nd@arm.com \
    --cc=ruifeng.wang@arm.com \
    --cc=stable@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).