Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Merge branch 'master' of framagit.org:simgrid/simgrid
authorMartin Quinson <martin.quinson@loria.fr>
Mon, 10 Sep 2018 12:42:52 +0000 (14:42 +0200)
committerMartin Quinson <martin.quinson@loria.fr>
Mon, 10 Sep 2018 12:42:52 +0000 (14:42 +0200)
1  2 
docs/source/app_s4u.rst

diff --combined docs/source/app_s4u.rst
@@@ -17,8 -17,8 +17,8 @@@ The S4U Interfac
     <br/>
  
  The S4U interface (SimGrid for you) mixes the full power of SimGrid
- with the full power of C++. This is the prefered interface to describe
- abstract algorithms in the domains of Cloud, P2P, HPC, IoT and similar
+ with the full power of C++. This is the preferred interface to describe
+ abstract algorithms in the domains of Cloud, P2P, HPC, IoT, and similar
  settings.
  
  -------------
@@@ -34,15 -34,15 +34,15 @@@ S4U interface to express thei
  and other |Activities|_, so that they get reflected within the
  simulator. These activities take place on resources such as |Hosts|_,
  |Links|_ and |Storages|_. SimGrid predicts the time taken by each
- activity and orchestrates accordingly the actors waiting for the
+ activity and orchestrates the actors accordingly, waiting for the
  completion of these activities.
  
  
  When **communicating**, data is not directly sent to other actors but
- posted onto a |Mailbox|_ that serve as rendez-vous point between
+ posted onto a |Mailbox|_ that serves as a rendez-vous point between
  communicating actors. This means that you don't need to know who you
 -are talking to, you just put your communication `Send` request in a
 -mailbox, and it will be matched with a complementary `Receive`
 +are talking to, you just put your communication `Put` request in a
 +mailbox, and it will be matched with a complementary `Get`
  request.  Alternatively, actors can interact through **classical
  synchronization mechanisms** such as |Barrier|_, |Semaphore|_,
  |Mutex|_ and |ConditionVariable|_.
@@@ -72,7 -72,7 +72,7 @@@ functions to simplify the code of actor
    - :ref:`class s4u::Link <exhale_class_classsimgrid_1_1s4u_1_1Link>`
      Interconnecting hosts.
    - :ref:`class s4u::NetZone <exhale_class_classsimgrid_1_1s4u_1_1NetZone>`:
-     Sub-region of the platform, containing resources (Hosts, Link, etc).
+     Sub-region of the platform, containing resources (Hosts, Links, etc).
    - :ref:`class s4u::Storage <exhale_class_classsimgrid_1_1s4u_1_1Storage>`
      Resource on which actors can write and read data.
    - :ref:`class s4u::VirtualMachine <exhale_class_classsimgrid_1_1s4u_1_1VirtualMachine>`:
  Activities
  ----------
  
- Activities represent the actions that consumes a resource, such as
+ Activities represent the actions that consume a resource, such as a
  :ref:`s4u::Comm <exhale_class_classsimgrid_1_1s4u_1_1Comm>` that
  consumes the *transmiting power* of :ref:`s4u::Link
  <exhale_class_classsimgrid_1_1s4u_1_1Link>` resources.
@@@ -152,11 -152,11 +152,11 @@@ create blocking communications: the act
  completion of that communication. Asynchronous communications do not
  block the actor during their execution but progress on their own.
  
- Once your asynchronous activity is started, you can test for
+ Once your asynchronous activity is started, you can test for its
  completion using :cpp:func:`s4u::Activity::test() <simgrid::s4u::Activity::test>`.
  This function returns ``true`` if the activity completed already.
  You can also use :cpp:func:`s4u::Activity::wait() <simgrid::s4u::Activity::wait>`
- to block until the completion of the activity. To wait at most for a given period,
+ to block until the completion of the activity. To wait for at most a given amount of time,
  use  :cpp:func:`s4u::Activity::wait_for() <simgrid::s4u::Activity::wait_for>`.
  Finally, to wait at most until a specified time limit, use
  :cpp:func:`s4u::Activity::wait_until() <simgrid::s4u::Activity::wait_until>`.
@@@ -189,7 -189,7 +189,7 @@@ vector of mailboxes
     :end-before: init-end
     :dedent: 4
  
You then start all communications that should occur concurrently with
Then, you start all the communications that should occur concurrently with
  :cpp:func:`s4u::Mailbox::put_async() <simgrid::s4u::Mailbox::put_async>`.  
  Finally, the actor waits for the completion of all of them at once
  with 
       
  .. literalinclude:: ../../examples/s4u/async-waitall/s4u-async-waitall.cpp
     :language: c++
 -   :start-after: send-begin
 -   :end-before: send-end
 +   :start-after: put-begin
 +   :end-before: put-end
     :dedent: 4