From d582caef5c257b2d192a7fa9feeb3f74ed2d07e4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ma=C3=ABl=20Madon?= <mael.madon@irit.fr>
Date: Mon, 20 Nov 2023 10:21:57 +0100
Subject: [PATCH] doc: fix typos
---
README.md | 8 ++++----
src/users/broker.hpp | 4 ++--
src/users/dynscheduler.hpp | 2 +-
src/users/user_model.hpp | 2 +-
4 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/README.md b/README.md
index 0767646..ead9189 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
# Batmen
-Batmen is a plugin to the scientific simulator [Batsim]. It allows to simulate users of large-scale distributed systems. Batmen is originally a fork of [batsched].
+Batmen is a plugin to the scientific simulator [Batsim]. It allows simulating users of large-scale distributed systems. Batmen is originally a fork of [batsched].
## How does it work?
@@ -13,7 +13,7 @@ A simulation with [Batsim] consists of two processes:
In Batmen, we added a layer: **the simulation of users**.
### User simulation
-The interaction with users happens through a "broker". The broker manages a pool of simulated users and dynamically register new jobs to sumbit. These jobs come on top of the input workload read by Batsim.
+The interaction with users happens through a "broker". The broker manages a pool of simulated users and dynamically register new jobs to submit. These jobs come on top of the input workload read by Batsim.
Implementation, in the folder `src/users`:
- class `Broker`: implement the broker, submitting the jobs on behalf of the users
@@ -22,9 +22,9 @@ Implementation, in the folder `src/users`:
### Types of user
-For now, we have developped three types of users.
+For now, we have developed three types of users.
-- *modelled users* (class `User`): using a model to generate the jobs to submit
+- *modeled users* (class `User`): using a model to generate the jobs to submit
- *replay users* (class `ReplayUser`): replaying a workload trace given as input
- *feedback users* (class `FeedbackUser`): taking feedback on the status of previous jobs into account when submitting the next one
diff --git a/src/users/broker.hpp b/src/users/broker.hpp
index b2d61f0..bc9836c 100644
--- a/src/users/broker.hpp
+++ b/src/users/broker.hpp
@@ -20,7 +20,7 @@ public:
/**
* @brief Returns the date (in seconds, rounded to the nearest) of the next
- * submission by the cloud broker.
+ * submission by the broker.
* @details Two numbers are used as flags:
* DATE_NEVER = -1 if the broker has finished to submit.
* DATE_UNKNOWN = -2 if the broker doesn't have a next submission date
@@ -39,7 +39,7 @@ public:
double date, list<Job> &jobs, list<const Profile *> &profiles);
/**
- * @brief Ackowledge the latest execution-related activity and forward the
+ * @brief Acknowledge the latest execution-related activity and forward the
* info to interested users.
*/
void feedback_job_status(double date, vector<string> &jobs_ended,
diff --git a/src/users/dynscheduler.hpp b/src/users/dynscheduler.hpp
index 602f72e..c5eb48e 100644
--- a/src/users/dynscheduler.hpp
+++ b/src/users/dynscheduler.hpp
@@ -6,7 +6,7 @@
/**
* A scheduler inheriting from this class will handle dynamic jobs submitted
- * by the cloud broker, if any.
+ * by the broker, if any.
* To do so, it asks the broker for the next submission date and uses batsim
* REQUESTED_CALL to come back to the broker when it has something to submit.
*/
diff --git a/src/users/user_model.hpp b/src/users/user_model.hpp
index d11e689..ef2ccad 100644
--- a/src/users/user_model.hpp
+++ b/src/users/user_model.hpp
@@ -70,7 +70,7 @@ private:
* @brief A user that thinks after the terminaison of her previous job before
* submitting a new one.
* @details When the job previously submitted finishes, the user is awaken by
- * the cloud broker. She waits for some time (the `think_time`) before
+ * the broker. She waits for some time (the `think_time`) before
* submitting the next one.
*/
class ThinkTimeUser : public User
--
GitLab