Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Typos.
authorArnaud Giersch <arnaud.giersch@univ-fcomte.fr>
Mon, 26 Jun 2023 13:01:52 +0000 (15:01 +0200)
committerArnaud Giersch <arnaud.giersch@univ-fcomte.fr>
Mon, 26 Jun 2023 13:35:46 +0000 (15:35 +0200)
[ci-skip]

ChangeLog
docs/source/Release_Notes.rst
examples/README.rst

index f790d04..ea236f2 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,4 +1,4 @@
-SimGrid (3.33.1) not released yet (target december 22)
+SimGrid (3.33.1) not released yet (target December 22)
 
   Save the planet, skip a release: 3.33 was due 6 months ago, so skip directly to 3.34.
 
@@ -22,7 +22,7 @@ S4U:
  - New Task abstraction: They are designed to represent dataflows, i.e, graphs of repeatable Activities.
    See the examples under examples/cpp/task-* and the associated documentation.
  - Full simDAG integration: Activity::start() actually starts only when all dependencies
-   are fullfiled. If it cannot be started right away, it will start as soon as it becomes
+   are fulfilled. If it cannot be started right away, it will start as soon as it becomes
    possible.
  - Allow to set a concurrency limit on disks and hosts, as it was already the case for links.
  - Rename Link::get_usage() to Link::get_load() for consistency with Host::
@@ -44,7 +44,7 @@ New S4U plugins:
    See the examples under examples/cpp/photovoltaic-* and the documentation in the Plugins page.
 
 Kernel:
- - optimize an internal datastructure (use a set instead of a list for ongoing activities),
+ - optimize an internal data structure (use a set instead of a list for ongoing activities),
    leading to a potentially big performance gain, in particular with many detached comms.
 
 MPI:
@@ -54,7 +54,7 @@ MPI:
 
 Models:
  - Write the section of the manual about models, at least.
- - WiFi: the total capacity of a link depends on the amout of flows on that link.
+ - WiFi: the total capacity of a link depends on the amount of flows on that link.
    - Use the nonlinear callback feature of LMM to reflect this.
    - Calibration values can be changed to match different MCS configurations
    - See the example teshsuite/models/wifi_usage_decay/wifi_usage_decay.cpp
@@ -79,12 +79,12 @@ sthread:
 Model checking:
  - Stateless model-checking is now usable on any system, including Mac OSX and ARM processors.
  - The stateless aspects of the MC are now enabled by default in all SimGrid builds.
-   Liveness and stateful aspects are still controled by the enabling_model-checking
+   Liveness and stateful aspects are still controlled by the enabling_model-checking
    configuration option.
  - Introducing ODPOR and SDPOR reduction strategies
  - Introducing guiding heuristics, trying to find bugs faster than DFS in reduced state space.
  - Synchronize the MBI tests with upstream.
- - Show the full actor bactraces when replaying a MC trace (with model-check/replay)
+ - Show the full actor backtraces when replaying a MC trace (with model-check/replay)
    and the status of all actors on deadlocks in MC mode.
 
 XBT:
index 66d6ec3..8d7681c 100644 (file)
@@ -571,12 +571,12 @@ stochastic generator of external load has been reintroduced.
 Version 3.33 (not released yet)
 -------------------------------
 
-**On the maintainance front,** we removed the ancient MSG interface which end-of-life was scheduled for 2020, the Java bindings
+**On the maintenance front,** we removed the ancient MSG interface which end-of-life was scheduled for 2020, the Java bindings
 that was MSG-only, support for native builds on Windows (WSL is now required) and support for 32 bits platforms. Keeping SimGrid
 alive while adding new features require to remove old, unused stuff. The very rare users impacted by these removals are urged to
 move to the new API and systems.
 
-We also conducted many internal refactorings to remove any occurence of "surf" and "simix". SimGrid v3.12 used a layered design
+We also conducted many internal refactorings to remove any occurrence of "surf" and "simix". SimGrid v3.12 used a layered design
 where simix was providing synchronizations to actors, on top of surf which was computing the models. These features are now
 provided in modules, not layers. Surf became the kernel::{lmm, resource, routing, timer, xml} modules while simix became
 the kernel::{activity, actor, context} modules.
@@ -589,7 +589,7 @@ the other models do. The *fair bottleneck* solver is convenient, but with less s
 development of its replacement (the *bmf solver*) is still ongoing. However, this combination of I/Os and
 communications seemed easier as these activities share the same unit (bytes).
 
-After a few tentatives, we opted for a simple, slightly unperfect, yet convenient way to implement such I/O streams at the
+After a few tentatives, we opted for a simple, slightly imperfect, yet convenient way to implement such I/O streams at the
 kernel level. It doesn't require a new model, just that the default HostModels implements a new function which creates a
 classical NetworkAction, but add some I/O-related constraints to it. A couple little hacks here and there, and done! A single
 activity mixing I/Os and communications can be created whose progress is limited by the resource (Disk or Link) of least
@@ -598,7 +598,7 @@ hosts. The user can specify a ``src_disk`` on a ``src_host`` and a ``dst_disk``
 given ``size``. Note that disks are optional, allowing users to simulate some kind of "disk-to-memory" or "memory-to-disk" I/O
 streams. It's highly inspired by the existing :cpp:func:`Comm::sendto` that can be used to send data between arbitrary hosts.
 
-We also modified the Wi-Fi model so that the total capacity of a link depends on the amout of flows on that link, accordingly to
+We also modified the Wi-Fi model so that the total capacity of a link depends on the amount of flows on that link, accordingly to
 the result of some ns-3 experiments. This model can be more accurate for congestioned Wi-Fi links, but its calibration is more
 demanding, as shown in the `example
 <https://framagit.org/simgrid/simgrid/tree/master/teshsuite/models/wifi_usage_decay/wifi_usage_decay.cpp>`_ and in the `research
@@ -606,7 +606,7 @@ paper <https://hal.archives-ouvertes.fr/hal-03777726>`_.
 
 We also worked on the usability of our models, by actually writing the long overdue documentation of our TCP models and by renaming
 some options for clarity (old names are still accepted as aliases). A new function ``s4u::Engine::flatify_platform()`` dumps an
-XML representation that is inefficient (all zones are flatified) but easier to read (routes are explicitely defined). You should
+XML representation that is inefficient (all zones are flatified) but easier to read (routes are explicitly defined). You should
 not use the output as a regular input file, but it will prove useful to double-check the your platform.
 
 **On the interface front**, some functions were deprecated and will be removed in 4 versions, while some old deprecated functions
@@ -614,9 +614,9 @@ were removed in this version, as usual.
 
 Expressing your application as a DAG or a workflow is even more integrated than before. We added a new tutorial on simulating
 DAGs and a DAG loader for workflows using the `wfcommons formalism <https://wfcommons.org/>`_. Starting an activity is now
-properly delayed until after all its dependencies are fullfiled. We also added a notion of :ref:`Task <API_s4u_Tasks>`, a sort
+properly delayed until after all its dependencies are fulfilled. We also added a notion of :ref:`Task <API_s4u_Tasks>`, a sort
 of activity that can be fired several time. It's very useful to represent complex workflows. We added a ``on_this`` variant of
-:ref:`every signal <s4u_API_signals>`, to react to the signals emited by one object instance only. This is sometimes easier than
+:ref:`every signal <s4u_API_signals>`, to react to the signals emitted by one object instance only. This is sometimes easier than
 reacting to every signals of a class, and then filtering on the object you want. Activity signals (veto, suspend, resume,
 completion) are now specialized by activity class. That is, callbacks registered in Exec::on_suspend_cb will not be fired for
 Comms nor Ios
@@ -636,7 +636,7 @@ with the :ref:`SMPI_app_instance_start() <SMPI_mix_s4u>` function.
 so that the model-checker only reads the memory of the application for state equality (used for liveness checking) and for
 :ref:`stateful checking <cfg=model-check/checkpoint>`. Instead, the network protocol is used to retrieve the information and the
 application is simply forked to explore new execution branches. The code is now easier to read and to understand. Even better,
-the verification of safety properties is now enabled by default on every platforms since it does depend on advanced OS
+the verification of safety properties is now enabled by default on every platforms since it does not depend on advanced OS
 mechanisms anymore. You can even run the verified application in valgrind in that case. On the other hand, liveness checking
 still needs to be enabled at compile time if you need it. Tbh, this part of the framework is not very well maintained nowadays.
 We should introduce more testing of the liveness verification at some point to fix this situation.
@@ -645,7 +645,7 @@ Back on to safety verification, we fixed a bug in the DPOR reduction which resul
 exploration, but this somewhat hinders the reduction quality (as we don't miss branches anymore). Some scenarios which could be
 exhaustively explored earlier (with our buggy algorithm) are now too large for our (correct) exploration algorithm. But that's
 not a problem because we implemented several mechanism to improve the performance of the verification. First, we implemented
-source sets in DPOR, to blacklist transitions that are redundent with previously explored ones. Then, we implemented several new
+source sets in DPOR, to blacklist transitions that are redundant with previously explored ones. Then, we implemented several new
 DPOR variants. SDPOR and ODPOR are very efficient algorithms described in the paper "Source Sets: A Foundation for Optimal
 Dynamic Partial Order Reduction" by Abdulla et al in 2017. We also have an experimental implementation of UPDOR, described in
 the paper "Unfolding-based Partial Order Reduction" by Rodriguez et al in 2015, but it's not completely functional yet. We hope
index 5e0220f..1370212 100644 (file)
@@ -366,7 +366,7 @@ Checking for incoming communications
 ------------------------------------
 
 This example uses ``Mailbox.ready()`` to check for completed communications. When this function returns true, then at least a message
-is arrived, so you know that ``Mailbox.get()`` will complete imediately. This is thus another way toward asynchronous communications.
+is arrived, so you know that ``Mailbox.get()`` will complete immediately. This is thus another way toward asynchronous communications.
 
 .. tabs::
 
@@ -620,7 +620,7 @@ on which they run is turned off: they are just terminated in this case, and thei
 failing hosts however, any blocking operation such as ``exec`` or ``wait`` will raise an exception that you can catch and react to. See also
 :ref:`howto_churn`,
 :ref:`this example <s4u_ex_platform_state_profile>` on how to attach a state profile to hosts, and
-:ref:`that example <s4u_ex_comm_failure>` on how to react to networ failures.
+:ref:`that example <s4u_ex_comm_failure>` on how to react to network failures.
 
 .. tabs::
 
@@ -727,7 +727,7 @@ schedules activities itself.
 Simple dependencies
 -------------------
 
-When you declare dependencies between two activities, the depedent will not actually start until all its dependencies complete,
+When you declare dependencies between two activities, the dependent will not actually start until all its dependencies complete,
 as shown in the following examples. The first one declare dependencies between executions while the second one declare
 dependencies between communications. You could declare such dependencies between arbitrary activities.
 
@@ -754,7 +754,7 @@ Simple DAG of activities
 ------------------------
 
 This example shows how to create activities from the maestro directly without relying on an actor, organize the dependencies of
-activities as a DAG (direct acyclic graph), and start them. Each activity will start as soon as its dependencies are fullfiled.
+activities as a DAG (direct acyclic graph), and start them. Each activity will start as soon as its dependencies are fulfilled.
 
 .. tabs::
 
@@ -791,7 +791,7 @@ to determine which host is the better fit for a given activity, and this example
 Loading DAGs from file
 ----------------------
 
-There is currently two file formats that you can load directly in SimGrid, but writting another loader for your beloved format should not be difficult.
+There is currently two file formats that you can load directly in SimGrid, but writing another loader for your beloved format should not be difficult.
 
 .. tabs::