all: Fix typos highlighted by codespell

Author: cassava

Doxyfile

@@ -1063,7 +1063,7 @@ HTML_STYLESHEET        =
 # defined cascading style sheet that is included after the standard style sheets
 # created by doxygen. Using this option one can overrule certain style aspects.
 # This is preferred over using HTML_STYLESHEET since it does not replace the
-# standard style sheet and is therefor more robust against future updates.
+# standard style sheet and is therefore more robust against future updates.
 # Doxygen will copy the style sheet file to the output directory. For an example
 # see the documentation.
 # This tag requires that the tag GENERATE_HTML is set to YES.
@@ -1935,7 +1935,7 @@ PREDEFINED             =
 EXPAND_AS_DEFINED      =
 
 # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
-# remove all refrences to function-like macros that are alone on a line, have an
+# remove all references to function-like macros that are alone on a line, have an
 # all uppercase name, and do not end with a semicolon. Such function macros are
 # typically used for boiler-plate code, and will confuse the parser if not
 # removed.

NOTICE.md

@@ -13,7 +13,7 @@ Eclipse Cloe is a trademark of the Eclipse Foundation.
 
 All content is the property of the respective authors or their employers.
 For more information regarding authorship of content, please consult the
-listed source code respository logs.
+listed source code repository logs.
 
 ## Declared Project Licenses
 

cli/cloe_launch/exec.py

@@ -65,7 +65,7 @@ class Environment:
         "PATH": "/bin:/usr/bin",
     }
     _preserve: List[str] = [
-        # Requried for XDG compliance:
+        # Required for XDG compliance:
         "XDG_.*",
         "HOME",
         "USER",

dist/docker/Dockerfile.ubuntu

@@ -3,7 +3,7 @@
 # This file acts partly as a Docker recipe for building Cloe on Ubuntu.
 # It is currently only tested with Ubuntu 18.04 and 20.04.
 #
-# If you are behing a proxy, make sure to pass in the respective HTTP_PROXY,
+# If you are behind a proxy, make sure to pass in the respective HTTP_PROXY,
 # HTTPS_PROXY, and NO_PROXY variables.
 ARG BUILD_FROM=ubuntu:18.04
 ARG DEPLOY_FROM=${BUILD_FROM}
@@ -73,7 +73,7 @@ RUN \
 # Create Deploy Image
 #
 # Unfortunately, there are still some issues with cloe-engine not finding
-# libcloe-runtime.so, so we need to explicitely set LD_LIBRARY_PATH.
+# libcloe-runtime.so, so we need to explicitly set LD_LIBRARY_PATH.
 #
 # This image can now be used to work with stack files. You should mount in
 # whatever directory contains your stack files for best results, otherwise

fable/include/fable/conf.hpp

@@ -87,7 +87,7 @@ class Conf {
    *   a) stdin
    *   b) command line
    *   c) network
-   * - This method hould not throw.
+   * - This method should not throw.
    */
   bool is_from_file() const { return !file_.empty(); }
 

fable/include/fable/confable.hpp

@@ -122,7 +122,7 @@ class Confable {
   /**
    * Serialize a Confable to Json.
    *
-   * Note: If you implment this type, make sure to either use CONFABLE_FRIENDS
+   * Note: If you implement this type, make sure to either use CONFABLE_FRIENDS
    * or a using Confable::to_json statement in your derived type.
    */
   virtual void to_json(Json& j) const { schema().to_json(j); }

fable/include/fable/schema.hpp

@@ -99,7 +99,7 @@
  * 3. Using types in schema namespace:
  *
  *      Schema MyData::schema_impl() {
- *        using namepsace schema;
+ *        using namespace schema;
  *        return Struct{
  *          {"host", String(&host, "hostname of connection").require()},
  *          {"port", Number<uint16_t>(&port, "port of connection").minimum(1024)},

fable/include/fable/schema/ignore.hpp

@@ -41,7 +41,7 @@ namespace schema {
  * deserialize it. This is much better than telling Struct to allow all
  * additional properties.
  *
- * Specifying the type is optional and serves only for documention purposes.
+ * Specifying the type is optional and serves only for documentation purposes.
  */
 class Ignore : public Base<Ignore> {
  public:  // Constructors

fable/include/fable/schema/interface.hpp

@@ -154,7 +154,7 @@ class Interface {
    *
    * When describing the schema of a primitive array, we can represent that as
    * a single string. But when the array contains an object, we wrap a single
-   * object in an array. This isn't awefully consistent, but it's the best we
+   * object in an array. This isn't awfully consistent, but it's the best we
    * can do.
    */
   virtual Json usage() const = 0;

plugins/basic/src/basic.cpp

@@ -222,14 +222,14 @@ struct AdaptiveCruiseControl {
       deviation_last = deviation;
       return (ukp + ukd + uki);
     };
-    // Implementation of the PID controll to control the speed
+    // Implementation of the PID control to control the speed
     double acc = pid_control(deviation, config.kp, config.kd, config.ki, deviation_last, uki_last);
     if (rabbit) {
       double target_distance = get_distance_algorithm().second(ego);
       double deviation_m = utility::distance_forward(*rabbit) - target_distance;
       double rabbit_m_s = vel + rabbit->velocity.sum();  // absolute rabbit velocity
       if (deviation_m < (fac_to_switch_control * target_distance) && rabbit_m_s < *target_speed) {
-        // Implementation of the PID controll to control the distance
+        // Implementation of the PID control to control the distance
         acc = pid_control(deviation_m, config.kp_m, config.kd_m, config.ki_m, deviation_m_last,
                           uki_m_last);
       }

plugins/basic/src/hmi_contact.hpp

@@ -90,7 +90,7 @@ namespace utility {
  * This phenomenon is modelled with this superclass, of which
  * Switch and PushButton are the primary subtypes.
  *
- * The function of switches occassionally changes based on the passage of time.
+ * The function of switches occasionally changes based on the passage of time.
  * What unit is used for time and what effect that has is parameterized via
  * templating.
  */

plugins/gndtruth_extractor/src/bimap.hpp

@@ -54,7 +54,7 @@ class BimapBase1 {
 /// Remarks:
 /// The methods defined by this class are not possible for a pair of identical template-arguments
 /// Therefore
-/// - a partial template specialization of this class exsits
+/// - a partial template specialization of this class exists
 /// - are BimapBase1 & BimapBase2 split into two classes
 template <typename Type1, typename Type2, typename CRTP>
 class BimapBase2 : public BimapBase1<Type1, Type2, CRTP> {

plugins/vtd/contrib/setups/Cloe.Default/Config/SimServer/simServer.xml

@@ -49,7 +49,7 @@
     <EnvVar name="VI_FILE_SUB_PATH"     val="$VI_FILE_SUB_PATH:Config/ScenarioEditor:Config/SensorManager:Config/DynamicsManager" />
     <EnvVar name="VI_FILE_SUB_PATH"     val="$VI_FILE_SUB_PATH:Config/ModuleManager:Config/Players:Plugins/SensorManager:Plugins/DynamicsManager:Plugins/ModuleManager" />
 
-    <!-- import Common/Config/Simulation/projectSettings.cfg in orignal plan, create IGLINKs, to see if could be deleted-->
+    <!-- import Common/Config/Simulation/projectSettings.cfg in original plan, create IGLINKs, to see if could be deleted-->
 
     <!-- internal COM ports -->
 

plugins/vtd/contrib/setups/Cloe.VirtualGL/Config/SimServer/simServer.xml

@@ -49,7 +49,7 @@
     <EnvVar name="VI_FILE_SUB_PATH"     val="$VI_FILE_SUB_PATH:Config/ScenarioEditor:Config/SensorManager:Config/DynamicsManager" />
     <EnvVar name="VI_FILE_SUB_PATH"     val="$VI_FILE_SUB_PATH:Config/ModuleManager:Config/Players:Plugins/SensorManager:Plugins/DynamicsManager:Plugins/ModuleManager" />
 
-    <!-- import Common/Config/Simulation/projectSettings.cfg in orignal plan, create IGLINKs, to see if could be deleted-->
+    <!-- import Common/Config/Simulation/projectSettings.cfg in original plan, create IGLINKs, to see if could be deleted-->
 
     <!-- internal COM ports -->
 

plugins/vtd/contrib/setups/Cloe.noGUI/Config/SimServer/simServer.xml

@@ -49,7 +49,7 @@
     <EnvVar name="VI_FILE_SUB_PATH"     val="$VI_FILE_SUB_PATH:Config/ScenarioEditor:Config/SensorManager:Config/DynamicsManager" />
     <EnvVar name="VI_FILE_SUB_PATH"     val="$VI_FILE_SUB_PATH:Config/ModuleManager:Config/Players:Plugins/SensorManager:Plugins/DynamicsManager:Plugins/ModuleManager" />
 
-    <!-- import Common/Config/Simulation/projectSettings.cfg in orignal plan, create IGLINKs, to see if could be deleted-->
+    <!-- import Common/Config/Simulation/projectSettings.cfg in original plan, create IGLINKs, to see if could be deleted-->
 
     <!-- internal COM ports -->
 

plugins/vtd/contrib/setups/Cloe.noGUInoIG/Config/SimServer/simServer.xml

@@ -47,7 +47,7 @@
     <EnvVar name="VI_FILE_SUB_PATH"     val="$VI_FILE_SUB_PATH:Config/ScenarioEditor:Config/SensorManager:Config/DynamicsManager" />
     <EnvVar name="VI_FILE_SUB_PATH"     val="$VI_FILE_SUB_PATH:Config/ModuleManager:Config/Players:Plugins/SensorManager:Plugins/DynamicsManager:Plugins/ModuleManager" />
 
-    <!-- import Common/Config/Simulation/projectSettings.cfg in orignal plan, create IGLINKs, to see if could be deleted-->
+    <!-- import Common/Config/Simulation/projectSettings.cfg in original plan, create IGLINKs, to see if could be deleted-->
 
     <!-- internal COM ports -->
 

plugins/vtd/contrib/setups/Cloe.noIG/Config/SimServer/simServer.xml

@@ -49,7 +49,7 @@
     <EnvVar name="VI_FILE_SUB_PATH"     val="$VI_FILE_SUB_PATH:Config/ScenarioEditor:Config/SensorManager:Config/DynamicsManager" />
     <EnvVar name="VI_FILE_SUB_PATH"     val="$VI_FILE_SUB_PATH:Config/ModuleManager:Config/Players:Plugins/SensorManager:Plugins/DynamicsManager:Plugins/ModuleManager" />
 
-    <!-- import Common/Config/Simulation/projectSettings.cfg in orignal plan, create IGLINKs, to see if could be deleted-->
+    <!-- import Common/Config/Simulation/projectSettings.cfg in original plan, create IGLINKs, to see if could be deleted-->
 
     <!-- internal COM ports -->
 

plugins/vtd/src/rdb_transceiver_shm.hpp

@@ -59,7 +59,7 @@ class RdbTransceiverShm : public RdbTransceiver {
   virtual ~RdbTransceiverShm();
 
   bool has() const override {
-    throw std::runtime_error("RdbTransceiverShm: has not implmented yet");
+    throw std::runtime_error("RdbTransceiverShm: has not implemented yet");
   }
 
   std::vector<std::shared_ptr<RDB_MSG_t>> receive() override;

runtime/include/cloe/core/logger.hpp

@@ -178,7 +178,7 @@ void set_factory(std::function<Logger(std::string)> factory);
 /**
  * Set the acceptable level of output for all loggers.
  *
- * This can be overriden on a per-logger basis. For example:
+ * This can be overridden on a per-logger basis. For example:
  * ```
  * logger:set_level(spdlog::level::error);
  * logger::get("cloe/webserver")->set_level(spdlog::level::info);

runtime/include/cloe/model.hpp

@@ -190,7 +190,7 @@ class Model : public Entity {
    * Construct a model.
    *
    * Construction must specify a name and optionally a description.
-   * The name must adhere to the regulations layed down in the Entity class.
+   * The name must adhere to the regulations laid down in the Entity class.
    *
    * A model should be considered disconnected after construction, that is
    * `is_connected()` should return false.

runtime/include/cloe/plugin.hpp

@@ -51,7 +51,7 @@
 
 /*
  * When creating a plugin, only the symbols that are loaded should be made
- * visibile. This can be achieved by setting compile options:
+ * visible. This can be achieved by setting compile options:
  *
  *     -fvisibility=hidden -fvisibility-inlines-hidden
  *

runtime/include/cloe/simulator.hpp

@@ -154,7 +154,7 @@ class Simulator : public Model {
    * Return a pointer to a Vehicle.
    *
    * - The argument i should be between [0, n), where n = num_vehicles().
-   * - If a vehicle index is accesed that is out-of-bounds, behaviour is
+   * - If a vehicle index is accessed that is out-of-bounds, behaviour is
    *   undefined.
    * - The simulator binding must manage the memory of the Vehicle.
    * - The pointer to the vehicle is guaranteed to be valid for the duration of

runtime/include/cloe/trigger.hpp

@@ -294,7 +294,7 @@ struct TriggerSchema {
  *
  * The default schema is an implicit one; that is, the factory takes no
  * configuration but can be called with the name only. An inline format
- * is therefore also implicitely supported.
+ * is therefore also implicitly supported.
  */
 template <typename T>
 class TriggerFactory : public Entity {
@@ -607,8 +607,8 @@ class AliasCallback : public Callback {
  * any further state is represented. This allows a new identical Action to be
  * created.
  *
- * The execution is achived through the function operator of the Action.
- * Any futher state required within the Action must be passed through
+ * The execution is achieved through the function operator of the Action.
+ * Any further state required within the Action must be passed through
  * the constructor of the Action.
  *
  * \see  cloe/trigger/example_actions.hpp
@@ -631,7 +631,7 @@ class Action : public Entity {
   virtual void operator()(const Sync&, TriggerRegistrar&) = 0;
 
   /**
-   * Return whether this action is a signficant action.
+   * Return whether this action is a significant action.
    *
    * All actions that have an effect on the result of a simulation are
    * significant. Actions that are not significant are:

runtime/include/cloe/utility/output_serializer.hpp

@@ -142,13 +142,13 @@ bool BasicFileOutputStream::open_file(const std::string& filename,
   }
 
   ofs_.open(output_file);
-  bool succes = !ofs_.fail();
-  if (succes) {
+  bool success = !ofs_.fail();
+  if (success) {
     logger_->info("Writing output to file: {}", output_file);
   } else {
     logger_->error("Error opening file for writing: {}", output_file);
   }
-  return succes;
+  return success;
 }
 
 void BasicFileOutputStream::close_stream() {

runtime/src/cloe/trigger/example_actions.cpp

@@ -215,7 +215,7 @@ ActionPtr PushReleaseFactory::make(const Conf& c) const {
     throw TriggerInvalid(c, "refuse to create action push_release with no buttons");
   }
 
-  auto creat = [&](bool val) -> ActionPtr {
+  auto create = [&](bool val) -> ActionPtr {
     auto j = Json{
         {"name", action},
     };
@@ -231,7 +231,7 @@ ActionPtr PushReleaseFactory::make(const Conf& c) const {
       {"buttons", buttons},
   };
 
-  return std::make_unique<PushRelease>(name(), dur, creat(true), creat(false), repr);
+  return std::make_unique<PushRelease>(name(), dur, create(true), create(false), repr);
 }
 
 }  // namespace actions

tests/test_engine_replica_smoketest.bats

@@ -42,7 +42,7 @@ cloe_engine_with_tmp_registry() {
     test -d $cloe_tmp_registry/smoketest
     mv "$cloe_tmp_registry/smoketest" "$cloe_tmp_registry/replica-1"
 
-    # Run the replica smoketest, writing to the same location as the inital
+    # Run the replica smoketest, writing to the same location as the initial
     # one.
     #
     # We have to include the config file from stdin so that the paths

tools/conan-server/Makefile

@@ -14,7 +14,7 @@ USER := $(shell id -un)
 .PHONY: help update add-group
 help:
 	@echo "Usage: make <target>"
-	@echo "Availabale targets:"
+	@echo "Available targets:"
 	@echo "  update     update permissions of files"
 	@echo "  add-group  add ${VOLUME_GROUP} for handling data"
 

tools/conan-server/README.md

@@ -5,7 +5,7 @@ This directory contains a Dockerized Conan server which can be used for testing
 and development of the Cloe Conan packages.
 
 It is possible to take this and use it as a Conan repository for production
-purposes, but it is explicitely discouraged by the Conan documentation.
+purposes, but it is explicitly discouraged by the Conan documentation.
 Instead, you should use Artifactory for this purpose.
 
 Usage
@@ -40,7 +40,7 @@ Now you can upload all the packages you want with:
     ...
 
 Because this can be an arduous task if you want to upload many packages,
-I recommand something along the lines of the following procedure:
+I recommend something along the lines of the following procedure:
 
     conan search --raw > packages.txt
     $EDITOR packages.txt

ui/src/App.js

@@ -226,7 +226,7 @@ class App extends Component {
     // Startup Phase 1: Render a message that UI is waiting for a Cloe host.
     // Startup Phase 2: Render an indicator for the Cloe initialization progress.
     // Startup Phase 3: Cloe is fully initialized, so render all UI components.
-    // Startup Phase 4: Cloe ist stopped, but last simulation state should still be rendered.
+    // Startup Phase 4: Cloe is stopped, but last simulation state should still be rendered.
     const waitingForCloeHost = <Spin className="mr-2" tip="Waiting for Cloe Host..." />;
     const waitingForCloeInit = (
       <React.Fragment>
@@ -460,7 +460,7 @@ class App extends Component {
     }
   };
 
-  // This method is used to fetch and return data from an spedified host and endpoint.
+  // This method is used to fetch and return data from a specified host and endpoint.
   getData = (host, endpoint) => {
     return axios.get(`http://${host}${this.apiPrefix}${endpoint}`).catch(function(error) {
       if (error.response) {

ui/src/components/chart.jsx

@@ -18,7 +18,7 @@ import { Scatter } from "react-chartjs-2";
 import "chartjs-plugin-zoom";
 
 // The Chart component creates a chart out of data.
-// Everytime the props 'nextXValue' and 'nextYValues' are changing,
+// Every time the props 'nextXValue' and 'nextYValues' are changing,
 // the component adds them to it"s data set and renders the new state.
 class Chart extends Component {
   constructor(props) {

ui/src/components/controller.jsx

@@ -52,8 +52,8 @@ class Controller extends Component {
         return <React.Fragment />;
       }
     } else {
-      // Fetch all definied api endpoints to update the
-      // data, generate the elements out of it.
+      // Fetch all defined API endpoints to update the data, generate the
+      // elements out of it.
       this.updateData();
       this.generateJSXComponent();
       return (

ui/src/components/simulation.jsx

@@ -21,7 +21,7 @@ import Slider from "react-rangeslider";
 
 // The Simulation component displays general Information about the simulation.
 // Each Information is represented by a Label component.
-// Aside from that, the Simulation commponent includes triggers to set the simulation speed.
+// Aside from that, the Simulation component includes triggers to set the simulation speed.
 class Simulation extends Component {
   state = {
     simSpeed: 100,
@@ -32,7 +32,7 @@ class Simulation extends Component {
     // Initial simSpeed has to be fetched from api by parent component,
     // so it is not available at mounting time.
     // Because of that, this function loops until the necessary prop
-    // is definied by the parent component.
+    // is defined by the parent component.
     if (!this.props.simulation) {
       window.setTimeout(this.setInitialSimSpeed, 100);
     } else {