diff --git a/BUILD.bazel b/BUILD.bazel index 3955fa5006..846a0c3ad5 100644 --- a/BUILD.bazel +++ b/BUILD.bazel @@ -58,7 +58,7 @@ alias( visibility = ["//visibility:public"], ) -# Execute `bazel run //:buildifier` to fix formating of all starlark files in the workspace +# Execute `bazel run //:buildifier` to fix formatting of all starlark files in the workspace buildifier( name = "buildifier", verbose = True, diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8132e608b0..45468091a5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -205,7 +205,7 @@ A good example for code formatting and doxygen structure can be found in [swe_do ### External dependencies External dependencies such as the [STL](https://en.wikipedia.org/wiki/Standard_Template_Library) or -other libaries shall be kept to a minium for `iceoryx_posh` and `iceoryx_hoofs`. If you think a new dependency is +other libraries shall be kept to a minimum for `iceoryx_posh` and `iceoryx_hoofs`. If you think a new dependency is necessary, do the following: 1. Contact the maintainers beforehand by opening an issue to discuss the necessity diff --git a/doc/design/diagrams/iceoryx_components_diagram_v3_0_0.puml b/doc/design/diagrams/iceoryx_components_diagram_v3_0_0.puml index 783773f75d..7e59e58e1b 100644 --- a/doc/design/diagrams/iceoryx_components_diagram_v3_0_0.puml +++ b/doc/design/diagrams/iceoryx_components_diagram_v3_0_0.puml @@ -48,7 +48,7 @@ package iceoryx_hoofs { component Primitives <> component Buffers <> component "Inter-process communication" <> - component "Threads & sychronisation" <> + component "Threads & synchronisation" <> component "Generalized design patterns & abstractions" <> component Reporting <> component Time <> diff --git a/doc/design/draft/service-discovery.md b/doc/design/draft/service-discovery.md index 3651846b14..143e45a0a2 100644 --- a/doc/design/draft/service-discovery.md +++ b/doc/design/draft/service-discovery.md @@ -80,7 +80,7 @@ change in the service registry and to transmit the service discovery registry. T Pro: -* Simple and consistent user API for both event-based and sychronous requests +* Simple and consistent user API for both event-based and synchronous requests * Filtering for `findService` could be done inside the new class * No need for a change counter as ABA problem solved by POSH mechanisms * Not just delta of service registry is transmitted, but complete service registry info @@ -96,7 +96,7 @@ Con: Note: * To avoid any out of memory issues with custom user-configured mempools or access rights problems, the publisher shall -write into the `iceoryx_managment` segment (same applies for the introspection publishers) +write into the `iceoryx_management` segment (same applies for the introspection publishers) ##### Alternative E: Introduce new StatusPort/ConfigPort/BroadcastPort @@ -117,7 +117,7 @@ only need read access and not write access * Fast data transport by using shared memory * Could replace `InterfacePort`s * Not just delta of service registry is transmitted, but complete service registry info -* Simple and consistent user API for both event-based and sychronous requests +* Simple and consistent user API for both event-based and synchronous requests * Filtering for `findService` could be done inside the new class Con: diff --git a/doc/design/error_reporting.md b/doc/design/error_reporting.md index ba03d740ad..207adbde9c 100644 --- a/doc/design/error_reporting.md +++ b/doc/design/error_reporting.md @@ -362,7 +362,7 @@ int resultOrAbort(int x) { auto result = algorithm(x); - // if a result was returned, we know that no error has occured + // if a result was returned, we know that no error has occurred return result; }; ``` diff --git a/doc/design/listener.md b/doc/design/listener.md index 23e9352cc2..5eb484b778 100644 --- a/doc/design/listener.md +++ b/doc/design/listener.md @@ -205,14 +205,14 @@ Listener Event_t Triggerable attached to the Triggerable so that it can notify the Listener/WaitSet via the underlying `ConditionNotifier` with `TriggerHandle::notify()`. The cleanup task is performed by the `m_resetCallback` so that the - Triggerable has no dependencies to any Notifyable. + Triggerable has no dependencies to any Notifiable. #### Condition Variable The `ConditionListener` and `ConditionNotifier` are two different interfaces to the same class which state is stored in the `ConditionVariableData` class. The intention of the separation is to provide one side (e.g. Triggerable) only -an API to notify the Notifyable (e.g. Listener) whereas the Notifyable can only +an API to notify the Notifiable (e.g. Listener) whereas the Notifiable can only wait on events. So the contract is reflected in the design. - **Problem:** Since the Listener reacts on events and not states it requires diff --git a/doc/design/lockfree_queue.md b/doc/design/lockfree_queue.md index 9686fadb85..44eaa8cf8b 100755 --- a/doc/design/lockfree_queue.md +++ b/doc/design/lockfree_queue.md @@ -133,7 +133,7 @@ we increase the cycle every n pushes (or pops), but the numbers representing the **Claim:** The queue push and pop operations are lock-free. -1. Push operations cannot block pop operaions arbitrarily long and vice versa. +1. Push operations cannot block pop operations arbitrarily long and vice versa. 2. Furthermore, between concurrent pushes and pops one of each type always succeeds in a finite amount of time. **Proof sketch:** @@ -146,7 +146,7 @@ we increase the cycle every n pushes (or pops), but the numbers representing the Therefore pushes and pops do not interfere to block each other. -Push operatios can block other push operations and pop operations other pop operations due to potential starvation, +Push operations can block other push operations and pop operations other pop operations due to potential starvation, but there will always be one operation that will complete (and therefore progress). This progress implies that the queue is lock-free. Note that there is no fairness guarantee. In principle the same push thread or pop thread might always succeed but in practice this is unlikely. diff --git a/doc/website/FAQ.md b/doc/website/FAQ.md index 21b0f55cc1..afe058f292 100644 --- a/doc/website/FAQ.md +++ b/doc/website/FAQ.md @@ -12,7 +12,7 @@ Check the `--shm-size` flag of the docker container. Does the container provide ## How can I find out if RouDi is running? -RouDi uses a file locking machanism to ensure that only one RouDi instance is running at a time. For that RouDi +RouDi uses a file locking mechanism to ensure that only one RouDi instance is running at a time. For that RouDi creates and locks `/tmp/roudi.lock`. The file exists also also when RouDi is not running. Try locking this file, if this fails RouDi is running. @@ -124,7 +124,7 @@ target_link_options(single_process BEFORE PRIVATE /STACK:3500000) For other platforms apply other flags or solutions. -### CI fails but error is locally not reproducable +### CI fails but error is locally not reproducible One can use `tools/scripts/ice_env.sh` to create an iceoryx development environment with a configuration very similar to the CI target. diff --git a/doc/website/advanced/configuration-guide.md b/doc/website/advanced/configuration-guide.md index 015e5ac292..f583e10da6 100644 --- a/doc/website/advanced/configuration-guide.md +++ b/doc/website/advanced/configuration-guide.md @@ -168,7 +168,7 @@ The TOML config file can be passed to RouDi with the `-c` command-line option. ./iox-roudi -c /absolute/path/to/config/file.toml ``` -This is an examplary config file with format version 1: +This is an exemplary config file with format version 1: ```TOML [general] diff --git a/doc/website/concepts/architecture.md b/doc/website/concepts/architecture.md index 641e4fb45f..79b3f848bd 100644 --- a/doc/website/concepts/architecture.md +++ b/doc/website/concepts/architecture.md @@ -36,7 +36,7 @@ This section describes the namespaces of the core library. protocol, which is used by `iceoryx_posh` to connect and discover `popo::Publisher` and `popo::Server`. * `mepoo`: The namespace memory pool contains all memory-related classes. For example the `MemoryManager` or `SharedPointer`. * `version`: The namespace version contains ABI compatibilities checks. -* `build`: The namespace build contains certain maximium values which can be changed before compilation. +* `build`: The namespace build contains certain maximum values which can be changed before compilation. #### Gateway library diff --git a/doc/website/getting-started/installation.md b/doc/website/getting-started/installation.md index 6431da0b1b..e458869221 100644 --- a/doc/website/getting-started/installation.md +++ b/doc/website/getting-started/installation.md @@ -102,7 +102,7 @@ Alternatively, `C:\Program Files (x86)\Microsoft Visual Studio\2022\Community\VC #### Setup for MinGW -`MinGW` can also be used to build iceoryx on Windows. The easist way to do this is to use `chocolatey`. +`MinGW` can also be used to build iceoryx on Windows. The easiest way to do this is to use `chocolatey`. ```powershell choco install -y mingw --version=10.3.0 diff --git a/doc/website/getting-started/overview.md b/doc/website/getting-started/overview.md index fcf959659b..6695d7a1c8 100644 --- a/doc/website/getting-started/overview.md +++ b/doc/website/getting-started/overview.md @@ -296,12 +296,12 @@ or clients. This way we can immediately wake up when data is available and avoid is available. One typical use case is to create a WaitSet, attach multiple subscribers and/or clients and user triggers and then -wait until one or many of the attached objects signal an event. If this happens one receives a list of all occured +wait until one or many of the attached objects signal an event. If this happens one receives a list of all occurred events called `notificationVector`. This makes it possible to collect data directly from the subscriber or client when it signals the WaitSet that new data or a new response is available. The WaitSet uses the [reactor pattern](https://en.wikipedia.org/wiki/Reactor_pattern) and is informed with a push -strategy that one of the attached events occured at which it informs the user. +strategy that one of the attached events occurred at which it informs the user. For more information on how to use the WaitSet see our [WaitSet examples](../../../iceoryx_examples/waitset). diff --git a/iceoryx_binding_c/include/iceoryx_binding_c/config.h b/iceoryx_binding_c/include/iceoryx_binding_c/config.h index 8e8fe5e7bb..50937ba806 100644 --- a/iceoryx_binding_c/include/iceoryx_binding_c/config.h +++ b/iceoryx_binding_c/include/iceoryx_binding_c/config.h @@ -85,7 +85,7 @@ uint32_t iox_cfg_no_user_header_alignment(void); /// runtime uint32_t iox_cfg_max_process_number(void); -/// @brief returns the maximum number of services that are supported byt the service registry +/// @brief returns the maximum number of services that are supported by the service registry uint32_t iox_cfg_service_registry_capacity(void); /// @brief returns the maximum number of services a findservice call can return diff --git a/iceoryx_binding_c/include/iceoryx_binding_c/notification_info.h b/iceoryx_binding_c/include/iceoryx_binding_c/notification_info.h index ed7ab1bba9..576e9e15ee 100644 --- a/iceoryx_binding_c/include/iceoryx_binding_c/notification_info.h +++ b/iceoryx_binding_c/include/iceoryx_binding_c/notification_info.h @@ -62,7 +62,7 @@ bool iox_notification_info_does_originate_from_server(iox_notification_info_t co /// @brief does the notification originate from a certain service discovery /// @param[in] self handle to notification info /// @param[in] serviceDiscovery handle to serviceDiscovery in question -/// @return true if the notifiaction originates from the service discovery, otherwise false +/// @return true if the notification originates from the service discovery, otherwise false bool iox_notification_info_does_originate_from_service_discovery(iox_notification_info_t const self, iox_service_discovery_t const serviceDiscovery); diff --git a/iceoryx_binding_c/include/iceoryx_binding_c/wait_set.h b/iceoryx_binding_c/include/iceoryx_binding_c/wait_set.h index a439897a39..0199dbb4e8 100644 --- a/iceoryx_binding_c/include/iceoryx_binding_c/wait_set.h +++ b/iceoryx_binding_c/include/iceoryx_binding_c/wait_set.h @@ -88,7 +88,7 @@ void iox_ws_mark_for_destruction(iox_ws_t const self); /// @param[in] subscriberState the state which should be attached /// @param[in] id an arbitrary id which will be tagged to the state /// @param[in] callback a callback which is attached to the state -/// @return if the attaching was successfull it returns WaitSetResult_SUCCESS, otherwise +/// @return if the attaching was successful it returns WaitSetResult_SUCCESS, otherwise /// an enum which describes the error enum iox_WaitSetResult iox_ws_attach_subscriber_state(iox_ws_t const self, iox_sub_t const subscriber, @@ -104,7 +104,7 @@ enum iox_WaitSetResult iox_ws_attach_subscriber_state(iox_ws_t const self, /// @param[in] id an arbitrary id which will be tagged to the state /// @param[in] callback a callback which is attached to the state /// @param[in] contextData a void pointer which is provided as second argument to the callback -/// @return if the attaching was successfull it returns WaitSetResult_SUCCESS, otherwise +/// @return if the attaching was successful it returns WaitSetResult_SUCCESS, otherwise /// an enum which describes the error enum iox_WaitSetResult iox_ws_attach_subscriber_state_with_context_data(iox_ws_t const self, iox_sub_t const subscriber, @@ -119,7 +119,7 @@ enum iox_WaitSetResult iox_ws_attach_subscriber_state_with_context_data(iox_ws_t /// @param[in] subscriberEvent the event which should be attached /// @param[in] eventId an arbitrary id which will be tagged to the event /// @param[in] callback a callback which is attached to the event -/// @return if the attaching was successfull it returns WaitSetResult_SUCCESS, otherwise +/// @return if the attaching was successful it returns WaitSetResult_SUCCESS, otherwise /// an enum which describes the error enum iox_WaitSetResult iox_ws_attach_subscriber_event(iox_ws_t const self, iox_sub_t const subscriber, @@ -135,7 +135,7 @@ enum iox_WaitSetResult iox_ws_attach_subscriber_event(iox_ws_t const self, /// @param[in] eventId an arbitrary id which will be tagged to the event /// @param[in] callback a callback which is attached to the event /// @param[in] contextData a void pointer which is provided as second argument to the callback -/// @return if the attaching was successfull it returns WaitSetResult_SUCCESS, otherwise +/// @return if the attaching was successful it returns WaitSetResult_SUCCESS, otherwise /// an enum which describes the error enum iox_WaitSetResult iox_ws_attach_subscriber_event_with_context_data(iox_ws_t const self, iox_sub_t const subscriber, @@ -149,7 +149,7 @@ enum iox_WaitSetResult iox_ws_attach_subscriber_event_with_context_data(iox_ws_t /// @param[in] userTrigger the user trigger of the event which should be attached /// @param[in] eventId an arbitrary id which will be tagged to the event /// @param[in] callback a callback which is attached to the event -/// @return if the attaching was successfull it returns WaitSetResult_SUCCESS, otherwise +/// @return if the attaching was successful it returns WaitSetResult_SUCCESS, otherwise /// an enum which describes the error enum iox_WaitSetResult iox_ws_attach_user_trigger_event(iox_ws_t const self, iox_user_trigger_t const userTrigger, @@ -163,7 +163,7 @@ enum iox_WaitSetResult iox_ws_attach_user_trigger_event(iox_ws_t const self, /// @param[in] eventId an arbitrary id which will be tagged to the event /// @param[in] callback a callback which is attached to the event /// @param[in] contextData a void pointer which is provided as second argument to the callback -/// @return if the attaching was successfull it returns WaitSetResult_SUCCESS, otherwise +/// @return if the attaching was successful it returns WaitSetResult_SUCCESS, otherwise /// an enum which describes the error enum iox_WaitSetResult iox_ws_attach_user_trigger_event_with_context_data(iox_ws_t const self, iox_user_trigger_t const userTrigger, @@ -198,7 +198,7 @@ void iox_ws_detach_user_trigger_event(iox_ws_t const self, iox_user_trigger_t co /// @param[in] clientEvent the event which should be attached /// @param[in] eventId an arbitrary id which will be tagged to the event /// @param[in] callback a callback which is attached to the event -/// @return if the attaching was successfull it returns WaitSetResult_SUCCESS, otherwise +/// @return if the attaching was successful it returns WaitSetResult_SUCCESS, otherwise /// an enum which describes the error enum iox_WaitSetResult iox_ws_attach_client_event(const iox_ws_t self, const iox_client_t client, @@ -213,7 +213,7 @@ enum iox_WaitSetResult iox_ws_attach_client_event(const iox_ws_t self, /// @param[in] eventId an arbitrary id which will be tagged to the event /// @param[in] callback a callback which is attached to the event /// @param[in] contextData a void pointer which is provided as second argument to the callback -/// @return if the attaching was successfull it returns WaitSetResult_SUCCESS, otherwise +/// @return if the attaching was successful it returns WaitSetResult_SUCCESS, otherwise /// an enum which describes the error enum iox_WaitSetResult iox_ws_attach_client_event_with_context_data(iox_ws_t const self, iox_client_t const client, @@ -228,7 +228,7 @@ enum iox_WaitSetResult iox_ws_attach_client_event_with_context_data(iox_ws_t con /// @param[in] clientState the state which should be attached /// @param[in] eventId an arbitrary id which will be tagged to the state /// @param[in] callback a callback which is attached to the state -/// @return if the attaching was successfull it returns WaitSetResult_SUCCESS, otherwise +/// @return if the attaching was successful it returns WaitSetResult_SUCCESS, otherwise /// an enum which describes the error enum iox_WaitSetResult iox_ws_attach_client_state(const iox_ws_t self, const iox_client_t client, @@ -243,7 +243,7 @@ enum iox_WaitSetResult iox_ws_attach_client_state(const iox_ws_t self, /// @param[in] eventId an arbitrary id which will be tagged to the state /// @param[in] callback a callback which is attached to the state /// @param[in] contextData a void pointer which is provided as second argument to the callback -/// @return if the attaching was successfull it returns WaitSetResult_SUCCESS, otherwise +/// @return if the attaching was successful it returns WaitSetResult_SUCCESS, otherwise /// an enum which describes the error enum iox_WaitSetResult iox_ws_attach_client_state_with_context_data(iox_ws_t const self, iox_client_t const client, @@ -270,7 +270,7 @@ void iox_ws_detach_client_state(iox_ws_t const self, iox_client_t const client, /// @param[in] serverEvent the server which should be attached /// @param[in] eventId an arbitrary id which will be tagged to the event /// @param[in] callback a callback which is attached to the event -/// @return if the attaching was successfull it returns WaitSetResult_SUCCESS, otherwise +/// @return if the attaching was successful it returns WaitSetResult_SUCCESS, otherwise /// an enum which describes the error enum iox_WaitSetResult iox_ws_attach_server_event(const iox_ws_t self, const iox_server_t server, @@ -285,7 +285,7 @@ enum iox_WaitSetResult iox_ws_attach_server_event(const iox_ws_t self, /// @param[in] eventId an arbitrary id which will be tagged to the event /// @param[in] callback a callback which is attached to the event /// @param[in] contextData a void pointer which is provided as second argument to the callback -/// @return if the attaching was successfull it returns WaitSetResult_SUCCESS, otherwise +/// @return if the attaching was successful it returns WaitSetResult_SUCCESS, otherwise /// an enum which describes the error enum iox_WaitSetResult iox_ws_attach_server_event_with_context_data(iox_ws_t const self, iox_server_t const server, @@ -300,7 +300,7 @@ enum iox_WaitSetResult iox_ws_attach_server_event_with_context_data(iox_ws_t con /// @param[in] serverState the state which should be attached /// @param[in] eventId an arbitrary id which will be tagged to the state /// @param[in] callback a callback which is attached to the state -/// @return if the attaching was successfull it returns WaitSetResult_SUCCESS, otherwise +/// @return if the attaching was successful it returns WaitSetResult_SUCCESS, otherwise /// an enum which describes the error enum iox_WaitSetResult iox_ws_attach_server_state(const iox_ws_t self, const iox_server_t server, @@ -315,7 +315,7 @@ enum iox_WaitSetResult iox_ws_attach_server_state(const iox_ws_t self, /// @param[in] eventId an arbitrary id which will be tagged to the state /// @param[in] callback a callback which is attached to the state /// @param[in] contextData a void pointer which is provided as second argument to the callback -/// @return if the attaching was successfull it returns WaitSetResult_SUCCESS, otherwise +/// @return if the attaching was successful it returns WaitSetResult_SUCCESS, otherwise /// an enum which describes the error enum iox_WaitSetResult iox_ws_attach_server_state_with_context_data(iox_ws_t const self, iox_server_t const server, @@ -342,7 +342,7 @@ void iox_ws_detach_server_state(iox_ws_t const self, iox_server_t const server, /// @param[in] serviceDiscoveryEvent the event which should be attached /// @param[in] eventId an arbitrary id which will be tagged to the event /// @param[in] callback a callback which is attached to the event -/// @return if the attaching was successfull it returns WaitSetResult_SUCCESS, otherwise +/// @return if the attaching was successful it returns WaitSetResult_SUCCESS, otherwise /// an enum which describes the error enum iox_WaitSetResult iox_ws_attach_service_discovery_event(const iox_ws_t self, const iox_service_discovery_t serviceDiscovery, @@ -357,7 +357,7 @@ enum iox_WaitSetResult iox_ws_attach_service_discovery_event(const iox_ws_t self /// @param[in] eventId an arbitrary id which will be tagged to the event /// @param[in] callback a callback which is attached to the event /// @param[in] contextData a void pointer which is provided as second argument to the callback -/// @return if the attaching was successfull it returns WaitSetResult_SUCCESS, otherwise +/// @return if the attaching was successful it returns WaitSetResult_SUCCESS, otherwise /// an enum which describes the error enum iox_WaitSetResult iox_ws_attach_service_discovery_event_with_context_data(iox_ws_t const self, diff --git a/iceoryx_examples/callbacks/README.md b/iceoryx_examples/callbacks/README.md index 1fb3d025ea..2d0dfed0ae 100644 --- a/iceoryx_examples/callbacks/README.md +++ b/iceoryx_examples/callbacks/README.md @@ -98,7 +98,7 @@ listener.attachEvent(heartbeat, iox::popo::createNotificationCallback(heartbeatC // It is possible to attach any c function here with a signature of void(iox::popo::Subscriber *). // But please be aware that the listener does not take ownership of the callback, therefore it has to exist as // long as the event is attached. Furthermore, it excludes lambdas which are capturing data since they are not -// convertable to a c function pointer. +// convertible to a c function pointer. // to simplify the example we attach the same callback onSampleReceivedCallback again listener .attachEvent(subscriberLeft, @@ -274,7 +274,7 @@ CounterService() { /// Attach the static method onSampleReceivedCallback and provide this as additional argument /// to the callback to gain access to the object whenever the callback is called. - /// It is not possible to use a lambda with capturing here since they are not convertable to + /// It is not possible to use a lambda with capturing here since they are not convertible to /// a C function pointer. /// important: the user has to ensure that the contextData (*this) lives as long as /// the subscriber with its callback is attached to the listener diff --git a/iceoryx_examples/callbacks/ice_callbacks_listener_as_class_member.cpp b/iceoryx_examples/callbacks/ice_callbacks_listener_as_class_member.cpp index 03c0c8afce..de0769d4c8 100644 --- a/iceoryx_examples/callbacks/ice_callbacks_listener_as_class_member.cpp +++ b/iceoryx_examples/callbacks/ice_callbacks_listener_as_class_member.cpp @@ -38,7 +38,7 @@ class CounterService { /// Attach the static method onSampleReceivedCallback and provide this as additional argument /// to the callback to gain access to the object whenever the callback is called. - /// It is not possible to use a lambda with capturing here since they are not convertable to + /// It is not possible to use a lambda with capturing here since they are not convertible to /// a C function pointer. /// important: the user has to ensure that the contextData (*this) lives as long as /// the subscriber with its callback is attached to the listener diff --git a/iceoryx_examples/callbacks/ice_callbacks_subscriber.cpp b/iceoryx_examples/callbacks/ice_callbacks_subscriber.cpp index 4b1956f94b..d678e9265b 100644 --- a/iceoryx_examples/callbacks/ice_callbacks_subscriber.cpp +++ b/iceoryx_examples/callbacks/ice_callbacks_subscriber.cpp @@ -102,7 +102,8 @@ int main() }); //! [create heartbeat] - // attach everything to the listener, from here on the callbacks are called when the corresponding event is occuring + // attach everything to the listener, from here on the callbacks are called when the corresponding event is + // occurring //! [attach everything] listener.attachEvent(heartbeat, iox::popo::createNotificationCallback(heartbeatCallback)).or_else([](auto) { std::cerr << "unable to attach heartbeat event" << std::endl; @@ -112,7 +113,7 @@ int main() // It is possible to attach any c function here with a signature of void(iox::popo::Subscriber *). // But please be aware that the listener does not take ownership of the callback, therefore it has to exist as // long as the event is attached. Furthermore, it excludes lambdas which are capturing data since they are not - // convertable to a c function pointer. + // convertible to a c function pointer. // to simplify the example we attach the same callback onSampleReceivedCallback again listener .attachEvent(subscriberLeft, diff --git a/iceoryx_examples/ice_access_control/README.md b/iceoryx_examples/ice_access_control/README.md index 6b9ef05891..80c3d3e05d 100644 --- a/iceoryx_examples/ice_access_control/README.md +++ b/iceoryx_examples/ice_access_control/README.md @@ -110,7 +110,7 @@ to the _privileged_ segment and is sending data into the _privileged_ shared mem The display app is started with the user _infotainment_, which is in the group _infotainment_ and _unprivileged_. Therefore it has read access to the _privileged_ segment. It reads the topic `{"Radar", "FrontLeft", "Object"}` from -the _privileged_ segment and forwards it as a slighty modified topic `{"Radar", "HMI-Display", "Object"}`. Because +the _privileged_ segment and forwards it as a slightly modified topic `{"Radar", "HMI-Display", "Object"}`. Because the user _infotainment_ is only in the _infotainment_ and _unprivileged_ group, it only has write access to the infotainment segment. Hence, the data is written to this segment. @@ -150,7 +150,7 @@ other::-- ``` !!! note - Note the shared memory managment segment (`iceoryx_mgmt`) is always available for everyone in the group `iceoryx` + Note the shared memory management segment (`iceoryx_mgmt`) is always available for everyone in the group `iceoryx` to **read** and **write**. #### Not-working setup diff --git a/iceoryx_examples/ice_access_control/iox_cheeky_app.cpp b/iceoryx_examples/ice_access_control/iox_cheeky_app.cpp index d71c69243c..bfdde97312 100644 --- a/iceoryx_examples/ice_access_control/iox_cheeky_app.cpp +++ b/iceoryx_examples/ice_access_control/iox_cheeky_app.cpp @@ -35,7 +35,7 @@ int main() iox::popo::Subscriber subscriber({"Radar", "FrontLeft", "Object"}); //! [subscriber] - // 2) The publisher object can't be initalised correctly because the user 'notallowed' isn't in any group which has + // 2) The publisher object can't be initialised correctly because the user 'notallowed' isn't in any group which has // write access to any shared memory segment. // The error POSH__RUNTIME_NO_WRITABLE_SHM_SEGMENT will be reported and programm execution will end //! [publisher] diff --git a/iceoryx_examples/iceoptions/iox_publisher_with_options.cpp b/iceoryx_examples/iceoptions/iox_publisher_with_options.cpp index 8b898a3416..34c5a663b2 100644 --- a/iceoryx_examples/iceoptions/iox_publisher_with_options.cpp +++ b/iceoryx_examples/iceoptions/iox_publisher_with_options.cpp @@ -55,7 +55,7 @@ int main() iox::popo::Publisher publisher({"Radar", "FrontLeft", "Object"}, publisherOptions); //! [create publisher with options] - // we have to explicitely offer the publisher for making it visible to subscribers + // we have to explicitly offer the publisher for making it visible to subscribers //! [offer] publisher.offer(); //! [offer] diff --git a/iceoryx_examples/iceperf/main_follower.cpp b/iceoryx_examples/iceperf/main_follower.cpp index 23805661b6..82564a4967 100644 --- a/iceoryx_examples/iceperf/main_follower.cpp +++ b/iceoryx_examples/iceperf/main_follower.cpp @@ -50,7 +50,7 @@ int main(int argc, char* argv[]) auto result = iox::convert::from_string(optarg); if (!result.has_value()) { - std::cerr << "Could not parse 'intensity' paramater!" << std::endl; + std::cerr << "Could not parse 'intensity' parameter!" << std::endl; return EXIT_FAILURE; } diff --git a/iceoryx_examples/iceperf/main_leader.cpp b/iceoryx_examples/iceperf/main_leader.cpp index 2b4300f5a6..1ebea6dcf2 100644 --- a/iceoryx_examples/iceperf/main_leader.cpp +++ b/iceoryx_examples/iceperf/main_leader.cpp @@ -120,7 +120,7 @@ int main(int argc, char* argv[]) auto result = iox::convert::from_string(optarg); if (!result.has_value()) { - std::cerr << "Could not parse 'number-of-samples' paramater!" << std::endl; + std::cerr << "Could not parse 'number-of-samples' parameter!" << std::endl; return EXIT_FAILURE; } settings.numberOfSamples = result.value(); diff --git a/iceoryx_examples/waitset/README.md b/iceoryx_examples/waitset/README.md index 9ecaed589b..64f01df6eb 100644 --- a/iceoryx_examples/waitset/README.md +++ b/iceoryx_examples/waitset/README.md @@ -52,7 +52,7 @@ samples present in the subscriber queue. ## Glossary - **Event** a state change of an object; a _Triggerable_ will signal an event via a _TriggerHandle_ to - a _Notifyable_. For instance one can attach the subscriber event `DATA_RECEIVED` to _WaitSet_. + a _Notifiable_. For instance one can attach the subscriber event `DATA_RECEIVED` to _WaitSet_. This will cause the subscriber to notify the WaitSet via the _TriggerHandle_ everytime a sample was received. - **NotificationCallback** a callback attached to a _NotificationInfo_. It must have the @@ -68,25 +68,25 @@ samples present in the subscriber queue. the _NotificationId_, call the _NotificationCallback_ or acquire the _NotificationOrigin_. - **NotificationOrigin** the pointer to the class where the _Event_ originated from, short pointer to the _Triggerable_. -- **Notifyable** is a class which listens to events. A _TriggerHandle_ which corresponds to a _Trigger_ - is used to notify the _Notifyable_ that an event occurred. The WaitSet is a _Notifyable_. +- **Notifiable** is a class which listens to events. A _TriggerHandle_ which corresponds to a _Trigger_ + is used to notify the _Notifiable_ that an event occurred. The WaitSet is a _Notifiable_. - **State** a specified set of values to which the members of an object are set. -- **Trigger** a class which is used by the _Notifyable_ to acquire the information which events were - signalled. It corresponds to a _TriggerHandle_. If the _Notifyable_ goes out of scope the corresponding +- **Trigger** a class which is used by the _Notifiable_ to acquire the information which events were + signalled. It corresponds to a _TriggerHandle_. If the _Notifiable_ goes out of scope the corresponding _TriggerHandle_ will be invalidated and if the _Triggerable_ goes out of scope the corresponding _Trigger_ will be invalidated. - **Triggerable** a class which has attached a _TriggerHandle_ to itself to signal - certain _Events_ to a _Notifyable_. -- **TriggerHandle** a thread-safe class which can be used to trigger a _Notifyable_. - If a _TriggerHandle_ goes out of scope it will detach itself from the _Notifyable_. A _TriggerHandle_ is + certain _Events_ to a _Notifiable_. +- **TriggerHandle** a thread-safe class which can be used to trigger a _Notifiable_. + If a _TriggerHandle_ goes out of scope it will detach itself from the _Notifiable_. A _TriggerHandle_ is logical equal to another _Trigger_ if they: - - are attached to the same _Notifyable_ (or in other words they are using the + - are attached to the same _Notifiable_ (or in other words they are using the same `ConditionVariable`) - they have the same _NotificationOrigin_ - they have the same callback to verify that they were triggered (`hasNotificationCallback`) - they have the same _NotificationId_ -- **WaitSet** a _Notifyable_ which manages a set of _Triggers_ which are corresponding to _Events_. +- **WaitSet** a _Notifiable_ which manages a set of _Triggers_ which are corresponding to _Events_. A user may attach or detach events. The _Waitset_ is listening to the whole set of _Triggers_ and if one or more _Triggers_ are triggered by an event it will notify the user. If a _WaitSet_ goes out of scope all attached _Triggers_ will be @@ -94,7 +94,7 @@ samples present in the subscriber queue. ## Quick Overview -**Events** or **States** can be attached to a **Notifyable** like the **WaitSet**. +**Events** or **States** can be attached to a **Notifiable** like the **WaitSet**. The **WaitSet** will listen on **Triggers** for a signal that an **Event** has occurred and it hands out **TriggerHandles** to **Triggerable** objects. The **TriggerHandle** is used to inform the **WaitSet** about the occurrence of an **Event**. When returning from `WaitSet::wait()` the user is provided with a vector of **NotificationInfos** @@ -763,11 +763,11 @@ bool isActivated() const noexcept ``` Since the following methods should not be accessible by the public but must be -accessible by any _Notifyable_ like the _WaitSet_ and to avoid that -we have to befriend every possible _Notifyable_ we created the `NotificationAttorney`. +accessible by any _Notifiable_ like the _WaitSet_ and to avoid that +we have to befriend every possible _Notifiable_ we created the `NotificationAttorney`. Every _Triggerable_ has to befriend the `NotificationAttorney` which provides access to the private methods `enableEvent`/`enableState`, `disableEvent`/`disableState`, `invalidateTrigger` and -`getCallbackForIsStateConditionSatisfied` to all _Notifyables_. +`getCallbackForIsStateConditionSatisfied` to all _Notifiables_. ```cpp diff --git a/iceoryx_examples/waitset/ice_waitset_trigger.cpp b/iceoryx_examples/waitset/ice_waitset_trigger.cpp index 85d2538db1..0fe8e033e0 100644 --- a/iceoryx_examples/waitset/ice_waitset_trigger.cpp +++ b/iceoryx_examples/waitset/ice_waitset_trigger.cpp @@ -130,7 +130,7 @@ class MyTriggerClass private: /// @brief Only usable by the WaitSet, not for public use // This method attaches a state of the class to a waitset. - // The state is choosen by the state parameter. Additionally, you can + // The state is chosen by the state parameter. Additionally, you can // set an eventId to group multiple instances and a custom callback. //! [enableState] void enableState(iox::popo::TriggerHandle&& triggerHandle, const MyTriggerClassStates state) noexcept @@ -149,7 +149,7 @@ class MyTriggerClass /// @brief Only usable by the WaitSet, not for public use // This method attaches an event of the class to a waitset. - // The event is choosen by the event parameter. Additionally, you can + // The event is chosen by the event parameter. Additionally, you can // set an eventId to group multiple instances and a custom callback. //! [enableEvent] void enableEvent(iox::popo::TriggerHandle&& triggerHandle, const MyTriggerClassEvents event) noexcept diff --git a/iceoryx_hoofs/cli/include/iox/cli/arguments.hpp b/iceoryx_hoofs/cli/include/iox/cli/arguments.hpp index 015eaf9ff4..77887a90fa 100644 --- a/iceoryx_hoofs/cli/include/iox/cli/arguments.hpp +++ b/iceoryx_hoofs/cli/include/iox/cli/arguments.hpp @@ -45,7 +45,7 @@ class Arguments /// @brief returns the value of a specified option /// @tparam T the type of the value /// @param[in] optionName either one letter for the shortOption or the whole longOption - /// @return the contained value if the value is present and convertable, otherwise an Error which describes the + /// @return the contained value if the value is present and convertible, otherwise an Error which describes the /// error template expected get(const OptionName_t& optionName) const noexcept; diff --git a/iceoryx_hoofs/concurrent/buffer/include/iox/detail/mpmc_lockfree_queue.hpp b/iceoryx_hoofs/concurrent/buffer/include/iox/detail/mpmc_lockfree_queue.hpp index c2a79202f1..76ea19cf1e 100644 --- a/iceoryx_hoofs/concurrent/buffer/include/iox/detail/mpmc_lockfree_queue.hpp +++ b/iceoryx_hoofs/concurrent/buffer/include/iox/detail/mpmc_lockfree_queue.hpp @@ -34,7 +34,7 @@ class MpmcLockFreeQueue public: using element_t = ElementType; - /// @brief creates and initalizes an empty MpmcLockFreeQueue + /// @brief creates and initializes an empty MpmcLockFreeQueue MpmcLockFreeQueue() noexcept; ~MpmcLockFreeQueue() noexcept = default; @@ -66,14 +66,14 @@ class MpmcLockFreeQueue /// @brief inserts value in FIFO order, always succeeds by removing the oldest value /// when the queue is detected to be full (overflow) /// @param value to be inserted is copied into the queue - /// @return removed value if an overflow occured, empty optional otherwise + /// @return removed value if an overflow occurred, empty optional otherwise /// @note threadsafe, lockfree iox::optional push(const ElementType& value) noexcept; /// @brief inserts value in FIFO order, always succeeds by removing the oldest value /// when the queue is detected to be full (overflow) /// @param value to be inserted is moved into the queue if possible - /// @return removed value if an overflow occured, empty optional otherwise + /// @return removed value if an overflow occurred, empty optional otherwise /// @note threadsafe, lockfree iox::optional push(ElementType&& value) noexcept; diff --git a/iceoryx_hoofs/concurrent/buffer/include/iox/detail/mpmc_lockfree_queue/cyclic_index.hpp b/iceoryx_hoofs/concurrent/buffer/include/iox/detail/mpmc_lockfree_queue/cyclic_index.hpp index 0313975428..b542320397 100644 --- a/iceoryx_hoofs/concurrent/buffer/include/iox/detail/mpmc_lockfree_queue/cyclic_index.hpp +++ b/iceoryx_hoofs/concurrent/buffer/include/iox/detail/mpmc_lockfree_queue/cyclic_index.hpp @@ -77,7 +77,7 @@ class CyclicIndex /// This is intended and includes the case were rhs is "very close to 0" and /// and lhs is "close" to the MAX of uint64_t (MAX=2^64-1). Here close means that /// the real absolute difference would be larger than 2^63. - /// This is excactly the right behaviour to deal with a (theoretically possible) + /// This is exactly the right behaviour to deal with a (theoretically possible) /// overflow of lhs and can be seen as lhs being interpreted as MAX + its actual value. /// In this case, lhs - rhs is positive even though lhs < rhs. int64_t operator-(const CyclicIndex& rhs) const noexcept; diff --git a/iceoryx_hoofs/concurrent/buffer/include/iox/detail/mpmc_lockfree_queue/mpmc_index_queue.hpp b/iceoryx_hoofs/concurrent/buffer/include/iox/detail/mpmc_lockfree_queue/mpmc_index_queue.hpp index f04144ca46..5274a0cd1c 100644 --- a/iceoryx_hoofs/concurrent/buffer/include/iox/detail/mpmc_lockfree_queue/mpmc_index_queue.hpp +++ b/iceoryx_hoofs/concurrent/buffer/include/iox/detail/mpmc_lockfree_queue/mpmc_index_queue.hpp @@ -85,7 +85,7 @@ class MpmcIndexQueue void push(const ValueType index) noexcept; /// @brief pop an index from the queue in FIFO order if the queue not empty - /// @return index if the queue was is empty, nullopt oterwise + /// @return index if the queue was is empty, nullopt otherwise optional pop() noexcept; /// @brief pop an index from the queue in FIFO order if the queue is full diff --git a/iceoryx_hoofs/concurrent/buffer/include/iox/detail/mpmc_lockfree_queue/mpmc_index_queue.inl b/iceoryx_hoofs/concurrent/buffer/include/iox/detail/mpmc_lockfree_queue/mpmc_index_queue.inl index 5c7680010a..90c411e72d 100644 --- a/iceoryx_hoofs/concurrent/buffer/include/iox/detail/mpmc_lockfree_queue/mpmc_index_queue.inl +++ b/iceoryx_hoofs/concurrent/buffer/include/iox/detail/mpmc_lockfree_queue/mpmc_index_queue.inl @@ -58,7 +58,7 @@ inline void MpmcIndexQueue::push(const ValueType index) noe // note that we are always able to succeed to publish since we have // enough capacity for all unique indices used - // case analyis + // case analysis // (1) loaded value is exactly one cycle behind: // value is from the last cycle // we can try to publish @@ -140,7 +140,7 @@ inline bool MpmcIndexQueue::pop(ValueType& index) noexcept // we need the CAS loop here since we may fail due to concurrent pop operations // we leave when we detect an empty queue, otherwise we retry the pop operation - // case analyis + // case analysis // (1) loaded value has the same cycle: // value was not popped before // try to get ownership @@ -205,7 +205,7 @@ inline bool MpmcIndexQueue::popIfFull(ValueType& index) noe // the queue is full if and only if write position and read position are the same but read position is // one cycle behind write position // unfortunately it seems impossible in this design to check this condition without loading - // write posiion and read position (which causes more contention) + // write position and read position (which causes more contention) const auto writePosition = m_writePosition.load(std::memory_order_relaxed); auto readPosition = m_readPosition.load(std::memory_order_relaxed); diff --git a/iceoryx_hoofs/concurrent/buffer/include/iox/detail/mpmc_lockfree_queue/mpmc_resizeable_lockfree_queue.inl b/iceoryx_hoofs/concurrent/buffer/include/iox/detail/mpmc_lockfree_queue/mpmc_resizeable_lockfree_queue.inl index f50d2f81f4..11b749d312 100644 --- a/iceoryx_hoofs/concurrent/buffer/include/iox/detail/mpmc_lockfree_queue/mpmc_resizeable_lockfree_queue.inl +++ b/iceoryx_hoofs/concurrent/buffer/include/iox/detail/mpmc_lockfree_queue/mpmc_resizeable_lockfree_queue.inl @@ -150,7 +150,7 @@ inline uint64_t MpmcResizeableLockFreeQueue::decreaseC // no free indices, try the used ones while (decreased < toDecrease) { - // remark: just calling pop to create free space is not sufficent in a concurrent scenario + // remark: just calling pop to create free space is not sufficient in a concurrent scenario // we want to make sure no one else gets the index once we have it if (!tryGetUsedIndex(index)) { diff --git a/iceoryx_hoofs/concurrent/buffer/include/iox/detail/mpmc_resizeable_lockfree_queue.hpp b/iceoryx_hoofs/concurrent/buffer/include/iox/detail/mpmc_resizeable_lockfree_queue.hpp index c29cbc02bf..ef72088a38 100644 --- a/iceoryx_hoofs/concurrent/buffer/include/iox/detail/mpmc_resizeable_lockfree_queue.hpp +++ b/iceoryx_hoofs/concurrent/buffer/include/iox/detail/mpmc_resizeable_lockfree_queue.hpp @@ -39,7 +39,7 @@ namespace concurrent // the call to the base class. // // Since supporting the resize (setCapacity) functionality has an impact on the runtime even -// if the feature is not used, we provide a queue wihout resize functionality in an additional +// if the feature is not used, we provide a queue without resize functionality in an additional // base class that can be used separately. template class MpmcResizeableLockFreeQueue : protected MpmcLockFreeQueue @@ -80,14 +80,14 @@ class MpmcResizeableLockFreeQueue : protected MpmcLockFreeQueue push(const ElementType& value) noexcept; /// @brief inserts value in FIFO order, always succeeds by removing the oldest value /// when the queue is detected to be full (overflow) /// @param[in] value to be inserted is moved into the queue if possible - /// @return removed value if an overflow occured, empty optional otherwise + /// @return removed value if an overflow occurred, empty optional otherwise /// @note threadsafe, lockfree iox::optional push(ElementType&& value) noexcept; diff --git a/iceoryx_hoofs/concurrent/sync/include/iox/smart_lock.hpp b/iceoryx_hoofs/concurrent/sync/include/iox/smart_lock.hpp index 14890bb686..5ae2c94dc1 100644 --- a/iceoryx_hoofs/concurrent/sync/include/iox/smart_lock.hpp +++ b/iceoryx_hoofs/concurrent/sync/include/iox/smart_lock.hpp @@ -76,7 +76,7 @@ class smart_lock const T& operator*() const noexcept; private: - // NOLINTJUSTIFICATION refences are intentionally used since the proxy object does not need to be assignable + // NOLINTJUSTIFICATION references are intentionally used since the proxy object does not need to be assignable // NOLINTBEGIN(cppcoreguidelines-avoid-const-or-ref-data-members) T& base; MutexType& lock; diff --git a/iceoryx_hoofs/concurrent/sync_extended/include/iox/detail/periodic_task.hpp b/iceoryx_hoofs/concurrent/sync_extended/include/iox/detail/periodic_task.hpp index 84edd73226..0f002c471d 100644 --- a/iceoryx_hoofs/concurrent/sync_extended/include/iox/detail/periodic_task.hpp +++ b/iceoryx_hoofs/concurrent/sync_extended/include/iox/detail/periodic_task.hpp @@ -45,7 +45,8 @@ struct PeriodicTaskManualStart_t static constexpr PeriodicTaskManualStart_t PeriodicTaskManualStart; /// @brief This class periodically executes a callable specified by the template parameter. -/// This can be a struct with a 'operator()()' overload, a 'iox::function_ref' or 'std::fuction'. +/// This can be a struct with a 'operator()()' overload, a 'iox::function_ref' or +/// 'std::function'. /// @code /// #include /// #include diff --git a/iceoryx_hoofs/container/include/iox/detail/list.inl b/iceoryx_hoofs/container/include/iox/detail/list.inl index f86702fe78..4de377ba93 100644 --- a/iceoryx_hoofs/container/include/iox/detail/list.inl +++ b/iceoryx_hoofs/container/include/iox/detail/list.inl @@ -56,7 +56,7 @@ inline list::list(list&& rhs) noexcept emplace(iter, std::move(element)); } - // optional clear(), but prefered to have defined state of source + // optional clear(), but preferred to have defined state of source rhs.clear(); } diff --git a/iceoryx_hoofs/container/include/iox/forward_list.hpp b/iceoryx_hoofs/container/include/iox/forward_list.hpp index 67c0c9de1f..de8a9c5afe 100644 --- a/iceoryx_hoofs/container/include/iox/forward_list.hpp +++ b/iceoryx_hoofs/container/include/iox/forward_list.hpp @@ -100,9 +100,9 @@ class forward_list /// @return reference to created list forward_list& operator=(forward_list&& rhs) noexcept; - /// @brief retrieve an interator before first element + /// @brief retrieve an iterator before first element /// only allowed for usage in erase_after, insert_after, emplace_after - /// Terminated when content is attemted to read (operator*, operator->) + /// Terminated when content is attempted to read (operator*, operator->) /// @return iterator to fictional element before first data element iterator before_begin() noexcept; @@ -111,12 +111,12 @@ class forward_list /// @return iterator to fictional element before first data element const_iterator before_begin() const noexcept; - /// @brief const_iterator an interator before first element + /// @brief const_iterator an iterator before first element /// only allowed for usage in erase_after, insert_after, emplace_after /// @return iterator to fictional element before first data element const_iterator cbefore_begin() const noexcept; - /// @brief default list operation to retrieve an interator to first list element + /// @brief default list operation to retrieve an iterator to first list element /// @return iterator to first list element, returns iterator to end() when list is empty iterator begin() noexcept; @@ -128,18 +128,18 @@ class forward_list /// @return iterator to first list element, returns iterator to end() when list is empty const_iterator cbegin() const noexcept; - /// @brief default list operation to retrieve an interator to end of list (behind last valid element) - /// Terminated when content is attemted to read (operator*, operator->) + /// @brief default list operation to retrieve an iterator to end of list (behind last valid element) + /// Terminated when content is attempted to read (operator*, operator->) /// @return iterator to end element, does not contain data. iterator end() noexcept; /// @brief default list operation to retrieve an const_iterator to end of list (behind last valid element) - /// Terminated when content is attemted to read (operator*, operator->) + /// Terminated when content is attempted to read (operator*, operator->) /// @return iterator to end element, does not contain data. const_iterator end() const noexcept; /// @brief default list operation to retrieve an const_iterator to end of list (behind last valid element) - /// Terminated when content is attemted to read (operator*, operator->) + /// Terminated when content is attempted to read (operator*, operator->) /// @return iterator to end element, does not contain data. const_iterator cend() const noexcept; @@ -185,7 +185,7 @@ class forward_list /// @return successful insertion (true), otherwise no element could be added to list (e.g. full -> false) bool push_front(T&& data) noexcept; - /// @brief remove the first element from the begining of the list + /// @brief remove the first element from the beginning of the list /// element destructor will be invoked /// @return successful removal (true), otherwise no element could be taken from list (e.g. empty -> false) bool pop_front() noexcept; @@ -215,7 +215,7 @@ class forward_list template size_type remove_if(UnaryPredicate pred) noexcept; - /// @brief construct element inplace at begining of list + /// @brief construct element inplace at beginning of list /// @param[in] args T-typed construction parameters (initializer list) /// @return referene to generated element, return is C++17-conform template diff --git a/iceoryx_hoofs/container/include/iox/list.hpp b/iceoryx_hoofs/container/include/iox/list.hpp index 977beccd2b..0285f7687c 100644 --- a/iceoryx_hoofs/container/include/iox/list.hpp +++ b/iceoryx_hoofs/container/include/iox/list.hpp @@ -102,7 +102,7 @@ class list list& operator=(list&& rhs) noexcept; - /// @brief default list operation to retrieve an interator to first list element + /// @brief default list operation to retrieve an iterator to first list element /// @return iterator to first list element, returns iterator to end() when list is empty iterator begin() noexcept; @@ -114,18 +114,18 @@ class list /// @return iterator to first list element, returns iterator to end() when list is empty const_iterator cbegin() const noexcept; - /// @brief default list operation to retrieve an interator to end of list (behind last valid element) - /// Terminated when content is attemted to read (operator*, operator->) + /// @brief default list operation to retrieve an iterator to end of list (behind last valid element) + /// Terminated when content is attempted to read (operator*, operator->) /// @return iterator to end element, does not contain data. iterator end() noexcept; /// @brief default list operation to retrieve an const_iterator to end of list (behind last valid element) - /// Terminated when content is attemted to read (operator*, operator->) + /// Terminated when content is attempted to read (operator*, operator->) /// @return iterator to end element, does not contain data. const_iterator end() const noexcept; /// @brief default list operation to retrieve an const_iterator to end of list (behind last valid element) - /// Terminated when content is attemted to read (operator*, operator->) + /// Terminated when content is attempted to read (operator*, operator->) /// @return iterator to end element, does not contain data. const_iterator cend() const noexcept; @@ -191,7 +191,7 @@ class list /// @return successful insertion (true), otherwise no element could be added to list (e.g. full -> false) bool push_back(T&& data) noexcept; - /// @brief remove the first element from the begining of the list + /// @brief remove the first element from the beginning of the list /// element destructor will be invoked /// @return successful removal (true), otherwise no element could be taken from list (e.g. empty -> false) bool pop_front() noexcept; @@ -226,7 +226,7 @@ class list template size_type remove_if(UnaryPredicate pred) noexcept; - /// @brief construct element inplace at begining of list + /// @brief construct element inplace at beginning of list /// @param[in] args T-typed construction parameters (initializer list) /// @return referene to generated element, return is C++17-conform template diff --git a/iceoryx_hoofs/container/include/iox/uninitialized_array.hpp b/iceoryx_hoofs/container/include/iox/uninitialized_array.hpp index aee2e0727a..169e401b45 100644 --- a/iceoryx_hoofs/container/include/iox/uninitialized_array.hpp +++ b/iceoryx_hoofs/container/include/iox/uninitialized_array.hpp @@ -71,7 +71,7 @@ struct NonZeroedBuffer /// @tparam Buffer is the policy parameter to choose between an uninitialized, not zeroed array (=NonZeroedBuffer, /// default) and an uninitialized array with all elements zeroed (=ZeroedBuffer) /// @note Out of bounds access leads to undefined behavior -// AXIVION Next Construct AutosarC++19_03-A9.6.1 : type contains a single member that is a byte array whos size is defined by ElementType and Capacity +// AXIVION Next Construct AutosarC++19_03-A9.6.1 : type contains a single member that is a byte array whose size is defined by ElementType and Capacity template class Buffer = NonZeroedBuffer> class UninitializedArray final { diff --git a/iceoryx_hoofs/container/include/iox/vector.hpp b/iceoryx_hoofs/container/include/iox/vector.hpp index 9eb716834e..bd0c8396a7 100644 --- a/iceoryx_hoofs/container/include/iox/vector.hpp +++ b/iceoryx_hoofs/container/include/iox/vector.hpp @@ -163,7 +163,7 @@ class vector final /// vector uint64_t size() const noexcept; - /// @brief returns true if the vector is emtpy, otherwise false + /// @brief returns true if the vector is empty, otherwise false bool empty() const noexcept; /// @brief calls the destructor of all contained elements and removes them diff --git a/iceoryx_hoofs/design/include/iox/move_and_copy_helper.hpp b/iceoryx_hoofs/design/include/iox/move_and_copy_helper.hpp index d070f1a190..a3d7c7cb6e 100644 --- a/iceoryx_hoofs/design/include/iox/move_and_copy_helper.hpp +++ b/iceoryx_hoofs/design/include/iox/move_and_copy_helper.hpp @@ -45,7 +45,7 @@ class MoveAndCopyHelper Opt == MoveAndCopyOperations::MoveAssignment || Opt == MoveAndCopyOperations::MoveConstructor; public: - /// @brief Creates or assigns an object to 'dest' based on the specail operation type. + /// @brief Creates or assigns an object to 'dest' based on the special operation type. /// @tparam T The type of the object to be created or assigned. /// @tparam V The type of the source object, kept as a universal reference to preserve its lvalue or rvalue nature. /// @param[out] dest The destination object where the new object is created or to which the source object is diff --git a/iceoryx_hoofs/design/include/iox/newtype.hpp b/iceoryx_hoofs/design/include/iox/newtype.hpp index b36439ba87..fd70822dcb 100644 --- a/iceoryx_hoofs/design/include/iox/newtype.hpp +++ b/iceoryx_hoofs/design/include/iox/newtype.hpp @@ -116,8 +116,8 @@ class NewType : public Policies>... constexpr NewType& operator=(T&& rhs) noexcept; /// @brief conversion operator - // AXIVION Next Construct AutosarC++19_03-A13.5.3 : needed to provide convertable policy so that the derived type - // can be convertable + // AXIVION Next Construct AutosarC++19_03-A13.5.3 : needed to provide convertible policy so that the derived type + // can be convertible constexpr explicit operator T() const noexcept; template diff --git a/iceoryx_hoofs/functional/include/iox/detail/storable_function.hpp b/iceoryx_hoofs/functional/include/iox/detail/storable_function.hpp index caee6b89c8..74612508cd 100644 --- a/iceoryx_hoofs/functional/include/iox/detail/storable_function.hpp +++ b/iceoryx_hoofs/functional/include/iox/detail/storable_function.hpp @@ -160,7 +160,7 @@ class storable_function> final /// @note For static_storage as the StorageType we detect at compile time if the functor can be stored. /// If this is not the case, compilation will fail. - /// For other StorageTypes where storing might fail due to insufficent memory this may not be detectable + /// For other StorageTypes where storing might fail due to insufficient memory this may not be detectable /// at compile time and we call terminate at runtime if the functor could not be stored. template // NOLINTNEXTLINE(performance-unnecessary-value-param) inline T* RelativePointer::getBasePtr(const segment_id_t id) noexcept { - // AXIVION Next Construct AutosarC++19_03-M5.2.8 : Cast to the underyling pointer type is safe as this is + // AXIVION Next Construct AutosarC++19_03-M5.2.8 : Cast to the underlying pointer type is safe as this is // encapsulated in the RelativePointer class and type safety is ensured by using templates return static_cast(getRepository().getBasePtr(static_cast(id))); } diff --git a/iceoryx_hoofs/memory/include/iox/detail/static_storage.hpp b/iceoryx_hoofs/memory/include/iox/detail/static_storage.hpp index daeebe73a9..59935ec19c 100644 --- a/iceoryx_hoofs/memory/include/iox/detail/static_storage.hpp +++ b/iceoryx_hoofs/memory/include/iox/detail/static_storage.hpp @@ -32,9 +32,9 @@ namespace iox /// @note We can define optimized_storage (or dynamic_storage) with a similar interface /// but other allocation policies and use them where we need to store objects -/// with some interchangable storage policy (e.g. in storable_function) +/// with some interchangeable storage policy (e.g. in storable_function) /// optimized_storage would have a dynamic memory fallback when static memory is -/// insufficent. +/// insufficient. template // NOLINTJUSTIFICATION static_storage provides uninitialized memory, correct initialization is the users // responsibility whenever memory with "allocate" is acquired diff --git a/iceoryx_hoofs/memory/include/iox/relocatable_ptr.hpp b/iceoryx_hoofs/memory/include/iox/relocatable_ptr.hpp index 170d497a41..ead673dc3c 100644 --- a/iceoryx_hoofs/memory/include/iox/relocatable_ptr.hpp +++ b/iceoryx_hoofs/memory/include/iox/relocatable_ptr.hpp @@ -42,7 +42,7 @@ namespace iox /// @note relocatable_ptr is not trivially copyable since in general the copy constructor /// requires additional logic. Hence obects that contain it re not trivially /// copyable in the C++ sense. However, if the pointees of a host object containing the -/// relocatable ptr are all located inside the object and the obect is otherwise trivially +/// relocatable ptr are all located inside the object and the object is otherwise trivially /// copyable it can be safely copied by memcpy. template class relocatable_ptr diff --git a/iceoryx_hoofs/memory/source/relative_pointer_data.cpp b/iceoryx_hoofs/memory/source/relative_pointer_data.cpp index 913813cf65..d87c42a161 100644 --- a/iceoryx_hoofs/memory/source/relative_pointer_data.cpp +++ b/iceoryx_hoofs/memory/source/relative_pointer_data.cpp @@ -29,7 +29,7 @@ static_assert(sizeof(RelativePointerData) <= RelativePointerData::MAX_ALLOWED_SI static_assert((sizeof(RelativePointerData)) == (alignof(RelativePointerData)), "A RelativePointerData must be placed on an address which does not cross the native alignment!"); // This is important for the use in the SOFI where under some conditions the copy operation could work on partially -// obsolet data and therefore non-trivial copy ctor/assignment operator or dtor would work on corrupted data. +// obsolete data and therefore non-trivial copy ctor/assignment operator or dtor would work on corrupted data. static_assert(std::is_trivially_copyable::value, "The RelativePointerData must be trivially copyable!"); diff --git a/iceoryx_hoofs/posix/design/include/iox/posix_call.hpp b/iceoryx_hoofs/posix/design/include/iox/posix_call.hpp index 19e87c37b2..f899c98ff5 100644 --- a/iceoryx_hoofs/posix/design/include/iox/posix_call.hpp +++ b/iceoryx_hoofs/posix/design/include/iox/posix_call.hpp @@ -107,7 +107,7 @@ class IOX_NO_DISCARD PosixCallEvaluator explicit PosixCallEvaluator(detail::PosixCallDetails& details) noexcept; private: - // NOLINTJUSTIFICATION refences are intentionally used since the class does not need to be assignable + // NOLINTJUSTIFICATION references are intentionally used since the class does not need to be assignable // NOLINTNEXTLINE(cppcoreguidelines-avoid-const-or-ref-data-members) detail::PosixCallDetails& m_details; }; @@ -140,7 +140,7 @@ class IOX_NO_DISCARD PosixCallVerificator explicit PosixCallVerificator(detail::PosixCallDetails& details) noexcept; private: - // NOLINTJUSTIFICATION refences are intentionally used since the class does not need to be assignable + // NOLINTJUSTIFICATION references are intentionally used since the class does not need to be assignable // NOLINTNEXTLINE(cppcoreguidelines-avoid-const-or-ref-data-members) detail::PosixCallDetails& m_details; }; diff --git a/iceoryx_hoofs/posix/filesystem/include/iox/detail/posix_acl.hpp b/iceoryx_hoofs/posix/filesystem/include/iox/detail/posix_acl.hpp index e8d201ee24..08d130451f 100644 --- a/iceoryx_hoofs/posix/filesystem/include/iox/detail/posix_acl.hpp +++ b/iceoryx_hoofs/posix/filesystem/include/iox/detail/posix_acl.hpp @@ -111,7 +111,7 @@ class PosixAcl /// @brief Write permission entries stored by the 'PosixAcl' to a file identified by a file descriptor. /// @param[fileDescriptor] identifier for a file (can be regular file, shared memory file, message queue file... /// everything is a file). - /// @return true if succesful. If false, you can assume that the file has not been touched at all. + /// @return true if successful. If false, you can assume that the file has not been touched at all. bool writePermissionsToFile(const int32_t fileDescriptor) const noexcept; private: diff --git a/iceoryx_hoofs/posix/filesystem/include/iox/file.hpp b/iceoryx_hoofs/posix/filesystem/include/iox/file.hpp index 7419b0ae9a..7abebd561b 100644 --- a/iceoryx_hoofs/posix/filesystem/include/iox/file.hpp +++ b/iceoryx_hoofs/posix/filesystem/include/iox/file.hpp @@ -104,7 +104,7 @@ enum class FileOffsetError : uint8_t }; /// @brief Represents a file. It supports various read and write functionalities -/// and can verify the existance of a file as well as remove existing files. +/// and can verify the existence of a file as well as remove existing files. class File : public FileManagementInterface { public: diff --git a/iceoryx_hoofs/posix/filesystem/source/file_lock.cpp b/iceoryx_hoofs/posix/filesystem/source/file_lock.cpp index 86ed2d7f6c..84df535715 100644 --- a/iceoryx_hoofs/posix/filesystem/source/file_lock.cpp +++ b/iceoryx_hoofs/posix/filesystem/source/file_lock.cpp @@ -108,7 +108,7 @@ FileLock& FileLock::operator=(FileLock&& rhs) noexcept { IOX_LOG(Error, "Unable to cleanup file lock \"" << m_fileLockPath - << "\" in the move constructor/move assingment operator"); + << "\" in the move constructor/move assignment operator"); } m_fileLockPath = std::move(rhs.m_fileLockPath); @@ -197,7 +197,7 @@ FileLockError FileLock::convertErrnoToFileLockError(const int32_t errnum, const case EFBIG: case EOVERFLOW: { - IOX_LOG(Error, "file lock \"" << fileLockPath << '"' << " is too large to be openend"); + IOX_LOG(Error, "file lock \"" << fileLockPath << '"' << " is too large to be opened"); return FileLockError::FILE_TOO_LARGE; } case ELOOP: diff --git a/iceoryx_hoofs/posix/ipc/source/named_pipe.cpp b/iceoryx_hoofs/posix/ipc/source/named_pipe.cpp index 7e99fa762e..b175b27c57 100644 --- a/iceoryx_hoofs/posix/ipc/source/named_pipe.cpp +++ b/iceoryx_hoofs/posix/ipc/source/named_pipe.cpp @@ -41,7 +41,7 @@ expected NamedPipeBuilder::create() const noexc if (m_name.size() + strlen(&NamedPipe::NAMED_PIPE_PREFIX[0]) > NamedPipe::MAX_MESSAGE_SIZE) { IOX_LOG(Error, - "The named pipe name: '" << m_name << "' is too long. Maxium name length is: " + "The named pipe name: '" << m_name << "' is too long. Maximum name length is: " << NamedPipe::MAX_MESSAGE_SIZE - strlen(&NamedPipe::NAMED_PIPE_PREFIX[0])); return err(PosixIpcChannelError::INVALID_CHANNEL_NAME); } diff --git a/iceoryx_hoofs/posix/time/include/iox/deadline_timer.hpp b/iceoryx_hoofs/posix/time/include/iox/deadline_timer.hpp index d133381ca1..bb37bc5b03 100644 --- a/iceoryx_hoofs/posix/time/include/iox/deadline_timer.hpp +++ b/iceoryx_hoofs/posix/time/include/iox/deadline_timer.hpp @@ -24,7 +24,7 @@ namespace iox { /// @brief This offers the deadline timer functionality. It has user convenient methods to reset the timer [by default -/// it uses the intialized duration], reset timer to a customized duration, check if the timer is active and user can +/// it uses the initialized duration], reset timer to a customized duration, check if the timer is active and user can /// also get to know about the remaining time before the timer goes off /// @code /// iox::deadline_timer deadlineTimer(1000_ms); diff --git a/iceoryx_hoofs/posix/time/include/iox/detail/adaptive_wait.hpp b/iceoryx_hoofs/posix/time/include/iox/detail/adaptive_wait.hpp index c67889967d..44ddc4e664 100644 --- a/iceoryx_hoofs/posix/time/include/iox/detail/adaptive_wait.hpp +++ b/iceoryx_hoofs/posix/time/include/iox/detail/adaptive_wait.hpp @@ -59,9 +59,9 @@ class adaptive_wait /// @note All numbers are not accurate and are just rough estimates /// acquired by the experiments described below. - /// @brief The value was choosen by educated guess. + /// @brief The value was chosen by educated guess. /// std::thread::sleep_for causes a lot of overhead. 100us was - /// choosen with the experiment below. The overhead of sleep_for is roughly around + /// chosen with the experiment below. The overhead of sleep_for is roughly around /// 50% of the actual waitingTime (100us). When the waitingTime is lower the /// overhead of sleep_for makes up the majority of the time yield is waiting. /// @code @@ -77,7 +77,7 @@ class adaptive_wait /// @endcode static constexpr std::chrono::microseconds INITIAL_WAITING_TIME{100}; - /// @brief The value was choosen by educated guess. + /// @brief The value was chosen by educated guess. /// With 10ms a busy loop is around 0.1% in top. when decreasing it /// to 5ms we get around 0.7% and then it starts to raise fast. static constexpr std::chrono::milliseconds FINAL_WAITING_TIME{10}; @@ -94,7 +94,7 @@ class adaptive_wait /// @endcode static constexpr uint64_t YIELD_REPETITIONS = 10000U; - /// @brief The initial repetition is choosen in a way that + /// @brief The initial repetition is chosen in a way that /// INITIAL_WAITING_TIME * 100U equals roughly FINAL_WAITING_TIME static constexpr uint64_t INITIAL_REPETITIONS = 100U + YIELD_REPETITIONS; diff --git a/iceoryx_hoofs/posix/time/source/deadline_timer.cpp b/iceoryx_hoofs/posix/time/source/deadline_timer.cpp index 4c8c5a2635..36b8d6c339 100644 --- a/iceoryx_hoofs/posix/time/source/deadline_timer.cpp +++ b/iceoryx_hoofs/posix/time/source/deadline_timer.cpp @@ -62,7 +62,7 @@ iox::units::Duration deadline_timer::getCurrentMonotonicTime() noexcept .failureReturnValue(-1) .evaluate() .has_error(), - "An error which should never happen occured during 'iox_clock_gettime'!"); + "An error which should never happen occurred during 'iox_clock_gettime'!"); return iox::units::Duration{time_since_epoch}; } } // namespace iox diff --git a/iceoryx_hoofs/primitives/include/iox/type_traits.hpp b/iceoryx_hoofs/primitives/include/iox/type_traits.hpp index 9767094d39..d8e4a58e2b 100644 --- a/iceoryx_hoofs/primitives/include/iox/type_traits.hpp +++ b/iceoryx_hoofs/primitives/include/iox/type_traits.hpp @@ -70,7 +70,7 @@ struct is_invocable } // AXIVION Next Construct AutosarC++19_03-A8.4.1 : we require a SFINEA failure case where all - // parameter types (non invokable ones) are allowed, this can be achieved with variadic arguments + // parameter types (non invocable ones) are allowed, this can be achieved with variadic arguments // This is chosen if Callable(ArgTypes) does not resolve to a valid type. template // NOLINTNEXTLINE(cert-dcl50-cpp) @@ -87,7 +87,7 @@ struct is_invocable /// @brief Verifies whether the passed Callable type is in fact invocable with the given arguments /// and the result of the invocation is convertible to ReturnType. /// -/// @note This is an implementation of std::is_invokable_r (C++17). +/// @note This is an implementation of std::is_invocable_r (C++17). /// template struct is_invocable_r @@ -100,7 +100,7 @@ struct is_invocable_r return {}; } // AXIVION Next Construct AutosarC++19_03-A8.4.1 : we require a SFINEA failure case where all - // parameter types (non invokable ones) are allowed, this can be achieved with variadic arguments + // parameter types (non invocable ones) are allowed, this can be achieved with variadic arguments template // NOLINTNEXTLINE(cert-dcl50-cpp) static constexpr std::false_type test(...) noexcept diff --git a/iceoryx_hoofs/reporting/include/iox/assertions.hpp b/iceoryx_hoofs/reporting/include/iox/assertions.hpp index 4fdaa20d99..d72e60e737 100644 --- a/iceoryx_hoofs/reporting/include/iox/assertions.hpp +++ b/iceoryx_hoofs/reporting/include/iox/assertions.hpp @@ -37,7 +37,7 @@ /// @brief calls panic handler and does not return /// @param message message to be forwarded -/// @note could actually throw if desired without breaking control flow asssumptions +/// @note could actually throw if desired without breaking control flow assumptions #define IOX_PANIC(message) iox::er::forwardPanic(IOX_CURRENT_SOURCE_LOCATION, message) //************************************************************************************************ diff --git a/iceoryx_hoofs/reporting/include/iox/error_reporting/configuration.hpp b/iceoryx_hoofs/reporting/include/iox/error_reporting/configuration.hpp index 85b3d80be2..8fa9869416 100644 --- a/iceoryx_hoofs/reporting/include/iox/error_reporting/configuration.hpp +++ b/iceoryx_hoofs/reporting/include/iox/error_reporting/configuration.hpp @@ -38,7 +38,7 @@ struct ConfigurationParameters { static_assert(std::is_same::value, "Incorrect configuration tag type"); - static constexpr bool CHECK_ASSERT{true}; /// @todo iox-#1032 deactive for release builds + static constexpr bool CHECK_ASSERT{true}; /// @todo iox-#1032 deactivate for release builds }; // used by the API to obtain the compile time parameters diff --git a/iceoryx_hoofs/reporting/include/iox/error_reporting/custom/default/configuration.hpp b/iceoryx_hoofs/reporting/include/iox/error_reporting/custom/default/configuration.hpp index fbb9fc226c..03347e245e 100644 --- a/iceoryx_hoofs/reporting/include/iox/error_reporting/custom/default/configuration.hpp +++ b/iceoryx_hoofs/reporting/include/iox/error_reporting/custom/default/configuration.hpp @@ -29,7 +29,7 @@ namespace er template <> struct ConfigurationParameters { - static constexpr bool CHECK_ASSERT{true}; /// @todo iox-#1032 deactive for release builds + static constexpr bool CHECK_ASSERT{true}; /// @todo iox-#1032 deactivate for release builds }; } // namespace er diff --git a/iceoryx_hoofs/reporting/include/iox/error_reporting/types.hpp b/iceoryx_hoofs/reporting/include/iox/error_reporting/types.hpp index f51f23d9ae..1b523dd0de 100644 --- a/iceoryx_hoofs/reporting/include/iox/error_reporting/types.hpp +++ b/iceoryx_hoofs/reporting/include/iox/error_reporting/types.hpp @@ -85,7 +85,7 @@ struct ModuleId }; // primary template is the identity -// this can be overriden by modules to handle specific errors +// this can be overridden by modules to handle specific errors template auto toError(ErrorLike&& value) { diff --git a/iceoryx_hoofs/reporting/include/iox/log/logstream.hpp b/iceoryx_hoofs/reporting/include/iox/log/logstream.hpp index 4ead848069..ab9f0fc12e 100644 --- a/iceoryx_hoofs/reporting/include/iox/log/logstream.hpp +++ b/iceoryx_hoofs/reporting/include/iox/log/logstream.hpp @@ -248,7 +248,7 @@ class LogStream /// @return a reference to the LogStream instance LogStream& operator<<(const bool val) noexcept; - // AXIVION DISABLE STYLE AutosarC++19_03-A3.9.1 : Basic numeric types are used in order to cover als basic numeric types, independent of the type alias + // AXIVION DISABLE STYLE AutosarC++19_03-A3.9.1 : Basic numeric types are used in order to cover also basic numeric types, independent of the type alias /// @brief Logging support for 'char' /// @param[in] val is the 'char' to log diff --git a/iceoryx_hoofs/test/moduletests/error_reporting/module_a/errors.hpp b/iceoryx_hoofs/test/moduletests/error_reporting/module_a/errors.hpp index 885855aa7c..17fdef1277 100644 --- a/iceoryx_hoofs/test/moduletests/error_reporting/module_a/errors.hpp +++ b/iceoryx_hoofs/test/moduletests/error_reporting/module_a/errors.hpp @@ -93,7 +93,7 @@ namespace er { // This definition must exist in this namespace for overload resolution. -// Each module must use a unqiue error enum, e.g. by namespace. +// Each module must use a unique error enum, e.g. by namespace. inline module_a::errors::Error toError(module_a::errors::Code code) { return module_a::errors::Error(code); diff --git a/iceoryx_hoofs/test/moduletests/error_reporting/module_b/errors.hpp b/iceoryx_hoofs/test/moduletests/error_reporting/module_b/errors.hpp index fc16864084..51aab8a47c 100644 --- a/iceoryx_hoofs/test/moduletests/error_reporting/module_b/errors.hpp +++ b/iceoryx_hoofs/test/moduletests/error_reporting/module_b/errors.hpp @@ -93,7 +93,7 @@ namespace er { // This definition must exist in this namespace for overload resolution. -// Each module must use a unqiue error enum, e.g. by namespace. +// Each module must use a unique error enum, e.g. by namespace. inline module_b::errors::Error toError(module_b::errors::Code code) { return module_b::errors::Error(code); diff --git a/iceoryx_hoofs/test/moduletests/error_reporting/test_custom_error_reporting.cpp b/iceoryx_hoofs/test/moduletests/error_reporting/test_custom_error_reporting.cpp index 534aa2a109..65deb8cf33 100644 --- a/iceoryx_hoofs/test/moduletests/error_reporting/test_custom_error_reporting.cpp +++ b/iceoryx_hoofs/test/moduletests/error_reporting/test_custom_error_reporting.cpp @@ -110,7 +110,7 @@ TEST_F(ErrorReporting_test, reportFatalErrorWorks) iox::testing::runInTestThread(f); // panic is not required at this level as we cannot trust the custom API to enforce it - // While we could also call panic in the custom API, there should only be one decison point + // While we could also call panic in the custom API, there should only be one decision point // for it at a higher level IOX_TESTING_EXPECT_ERROR(ERROR_CODE); } diff --git a/iceoryx_hoofs/test/moduletests/error_reporting/test_error_reporting_violation.cpp b/iceoryx_hoofs/test/moduletests/error_reporting/test_error_reporting_violation.cpp index 02fb6c5f1b..68abb29cc3 100644 --- a/iceoryx_hoofs/test/moduletests/error_reporting/test_error_reporting_violation.cpp +++ b/iceoryx_hoofs/test/moduletests/error_reporting/test_error_reporting_violation.cpp @@ -56,7 +56,7 @@ class ErrorType_test : public Test }; // We can extend this easily for other error types as they have to conform to the same interface -// Any error type must satsify these tests. +// Any error type must satisfy these tests. using TestTypes = Types; TYPED_TEST_SUITE(ErrorType_test, TestTypes, ); diff --git a/iceoryx_hoofs/test/moduletests/test_concurrent_mpmc_resizeable_lockfree_queue.cpp b/iceoryx_hoofs/test/moduletests/test_concurrent_mpmc_resizeable_lockfree_queue.cpp index a6b0eb0174..1392ba5d0f 100644 --- a/iceoryx_hoofs/test/moduletests/test_concurrent_mpmc_resizeable_lockfree_queue.cpp +++ b/iceoryx_hoofs/test/moduletests/test_concurrent_mpmc_resizeable_lockfree_queue.cpp @@ -401,7 +401,7 @@ TYPED_TEST(MpmcResizeableLockFreeQueueTest, setCapacityOfFullQueueToHalfOfMaxCap EXPECT_EQ(q.size(), NEW_CAP); // the least recent values are removed due to the capacity being decreased - // how man elements remain depends on whether MAX_CAP is divisable by 2 + // how man elements remain depends on whether MAX_CAP is divisible by 2 for (element = NEW_CAP + MAX_CAP % 2U; element < MAX_CAP; ++element) { auto result = q.pop(); @@ -433,7 +433,7 @@ TYPED_TEST(MpmcResizeableLockFreeQueueTest, setCapacityOfFullQueueToHalfOfMaxCap EXPECT_EQ(removedElements.size(), MAX_CAP / 2 + MAX_CAP % 2U); // the least recent values are removed due to the capacity being decreased - // how many elements remain depends on whether MAX_CAP is divisable by 2 + // how many elements remain depends on whether MAX_CAP is divisible by 2 for (element = NEW_CAP + MAX_CAP % 2U; element < MAX_CAP; ++element) { auto result = q.pop(); diff --git a/iceoryx_hoofs/test/moduletests/test_design_newtype.cpp b/iceoryx_hoofs/test/moduletests/test_design_newtype.cpp index a84d3441c7..e28bda1137 100644 --- a/iceoryx_hoofs/test/moduletests/test_design_newtype.cpp +++ b/iceoryx_hoofs/test/moduletests/test_design_newtype.cpp @@ -26,7 +26,7 @@ struct ComplexType { uint64_t value{0}; - // the test requires the type to be implicit convertable + // the test requires the type to be implicit convertible // NOLINTNEXTLINE(hicpp-explicit-conversions) ComplexType(uint64_t v) : value(v) diff --git a/iceoryx_hoofs/test/moduletests/test_design_static_lifetime_guard.cpp b/iceoryx_hoofs/test/moduletests/test_design_static_lifetime_guard.cpp index 14d1297fb2..d87d83de03 100644 --- a/iceoryx_hoofs/test/moduletests/test_design_static_lifetime_guard.cpp +++ b/iceoryx_hoofs/test/moduletests/test_design_static_lifetime_guard.cpp @@ -345,7 +345,7 @@ TEST_F(StaticLifetimeGuard_test, instanceCtorIsConcurrentlyCalledExactlyOnce) auto createInstance = [&barrier]() { barrier.notify(); barrier.wait(); - // all threads have notfied (but may pass wait in any order ...) + // all threads have notified (but may pass wait in any order ...) // cannot wait too long otherwise we slow down the tests too much, // cannot be optimized away, as it has side effects (counting) diff --git a/iceoryx_hoofs/test/moduletests/test_memory_relative_pointer.cpp b/iceoryx_hoofs/test/moduletests/test_memory_relative_pointer.cpp index bf2668b594..41eb883e3a 100644 --- a/iceoryx_hoofs/test/moduletests/test_memory_relative_pointer.cpp +++ b/iceoryx_hoofs/test/moduletests/test_memory_relative_pointer.cpp @@ -449,7 +449,7 @@ TYPED_TEST(RelativePointer_test, MemoryRemappingWorks) EXPECT_EQ(rp1.getId(), 1U); EXPECT_EQ(rp2.getId(), 2U); - // relative to their respective memory block base adress both have the same offset + // relative to their respective memory block base address both have the same offset EXPECT_EQ(rp1.getOffset(), offset); EXPECT_EQ(rp2.getOffset(), offset); diff --git a/iceoryx_hoofs/test/moduletests/test_memory_static_storage.cpp b/iceoryx_hoofs/test/moduletests/test_memory_static_storage.cpp index 7eca68eea3..9cf9df4c3f 100644 --- a/iceoryx_hoofs/test/moduletests/test_memory_static_storage.cpp +++ b/iceoryx_hoofs/test/moduletests/test_memory_static_storage.cpp @@ -133,7 +133,7 @@ TEST(static_storage_test, TypedAllocateSucceedsIfSizeIsSufficient) using Data = Bytes<16, 4>; static_storage<18, 2> sut; EXPECT_NE(sut.allocate(), nullptr); - // when size of storage is insufficent it will not compile and + // when size of storage is insufficient it will not compile and // therefore cannot be tested } diff --git a/iceoryx_hoofs/test/moduletests/test_posix_filesystem_posix_acl.cpp b/iceoryx_hoofs/test/moduletests/test_posix_filesystem_posix_acl.cpp index ac77b13267..272b2f6237 100644 --- a/iceoryx_hoofs/test/moduletests/test_posix_filesystem_posix_acl.cpp +++ b/iceoryx_hoofs/test/moduletests/test_posix_filesystem_posix_acl.cpp @@ -85,7 +85,7 @@ std::unique_ptr iox_getpwuid(const iox_uid_t uid) TEST_F(PosixAcl_test, writeStandardPermissions) { ::testing::Test::RecordProperty("TEST_ID", "4313fc8d-b819-4c77-b811-80e2a41cf3bd"); - // should fail beacuse no access rights have been specified yet + // should fail because no access rights have been specified yet bool result = m_accessController.writePermissionsToFile(m_fileDescriptor); EXPECT_FALSE(result); diff --git a/iceoryx_hoofs/test/moduletests/test_posix_shared_memory.cpp b/iceoryx_hoofs/test/moduletests/test_posix_shared_memory.cpp index 54830c101d..7b3cc7c078 100644 --- a/iceoryx_hoofs/test/moduletests/test_posix_shared_memory.cpp +++ b/iceoryx_hoofs/test/moduletests/test_posix_shared_memory.cpp @@ -155,7 +155,7 @@ TEST_F(PosixSharedMemory_Test, UnlinkExistingShmWorks) ASSERT_FALSE(result.has_error()); EXPECT_TRUE(*result); - // delete the underyling fd pointer but do not cleanup raw shared memory since + // delete the underlying fd pointer but do not cleanup raw shared memory since // is is already deleted with unlinkIfExist in the test delete rawSharedMemory.release(); } diff --git a/iceoryx_hoofs/test/stresstests/sofi/test_stress_spsc_sofi.cpp b/iceoryx_hoofs/test/stresstests/sofi/test_stress_spsc_sofi.cpp index d5432cefb6..abd30daf22 100644 --- a/iceoryx_hoofs/test/stresstests/sofi/test_stress_spsc_sofi.cpp +++ b/iceoryx_hoofs/test/stresstests/sofi/test_stress_spsc_sofi.cpp @@ -44,7 +44,7 @@ class SpscSofiStress : public Test /// /// @param cpu is the CPU the thread shall use /// @param nativeHandle is the native handle of the c++11 std::thread - /// @return bool: if true, setting the affinity was successfull + /// @return bool: if true, setting the affinity was successful // NOLINTNEXTLINE(bugprone-easily-swappable-parameters) used only for test purposes static bool setCpuAffinity(unsigned int cpu, std::thread::native_handle_type nativeHandle) { @@ -194,7 +194,7 @@ TEST_F(SpscSofiStress, SimultaneouslyPushAndPopOnEmptySoFi) EXPECT_THAT(pushCounter / 1000, Gt(STRESS_TIME.count())) << "There should be at least 1000 pushes per millisecond!"; EXPECT_THAT(tryPopCounter / 4, Gt(popCounter)) - << "There should be at least 4 times as many trys to pop as actual pops!"; + << "There should be at least 4 times as many tries to pop as actual pops!"; EXPECT_THAT(pushCounter, Eq(popCounter)) << "Push and Pop Counter should be Equal after the Test!"; IOX_LOG(Info, "try pop counter: " << tryPopCounter); diff --git a/iceoryx_hoofs/test/stresstests/test_mpmc_resizeable_lockfree_queue_stresstest.cpp b/iceoryx_hoofs/test/stresstests/test_mpmc_resizeable_lockfree_queue_stresstest.cpp index 59df0bc220..ff1fc11641 100644 --- a/iceoryx_hoofs/test/stresstests/test_mpmc_resizeable_lockfree_queue_stresstest.cpp +++ b/iceoryx_hoofs/test/stresstests/test_mpmc_resizeable_lockfree_queue_stresstest.cpp @@ -599,7 +599,7 @@ TYPED_TEST(MpmcResizeableLockFreeQueueStressTest, HybridMultiProducerMultiConsum /// which use potentially overflowing pushes. /// The tests initializes a local list of distinct elements for each thread. /// The queue is also filled with distinct elements to ensure we will have an overflow. -/// Each thread chooses randomly between push and pop (preference is controllable, to make overlflow more or less +/// Each thread chooses randomly between push and pop (preference is controllable, to make overflow more or less /// likely). /// The test runs for some specified time and upon completion it is checked that /// aggregated over the queue and the local lists of each thread diff --git a/iceoryx_hoofs/time/source/duration.cpp b/iceoryx_hoofs/time/source/duration.cpp index bc9c45db1d..2f2d5e6a6c 100644 --- a/iceoryx_hoofs/time/source/duration.cpp +++ b/iceoryx_hoofs/time/source/duration.cpp @@ -54,7 +54,7 @@ struct timespec Duration::timespec(const TimeSpecReference reference) const noex const iox_clockid_t clockId{(reference == TimeSpecReference::Epoch) ? CLOCK_REALTIME : CLOCK_MONOTONIC}; IOX_ENFORCE( !IOX_POSIX_CALL(iox_clock_gettime)(clockId, &referenceTime).failureReturnValue(-1).evaluate().has_error(), - "An error which should never happen occured during 'iox_clock_gettime'!"); + "An error which should never happen occurred during 'iox_clock_gettime'!"); const auto targetTime = Duration(referenceTime) + *this; diff --git a/iceoryx_hoofs/vocabulary/include/iox/string.hpp b/iceoryx_hoofs/vocabulary/include/iox/string.hpp index 3bddd2f741..f88a9b05c3 100644 --- a/iceoryx_hoofs/vocabulary/include/iox/string.hpp +++ b/iceoryx_hoofs/vocabulary/include/iox/string.hpp @@ -472,8 +472,8 @@ class string final /// string optional> substr(const uint64_t pos = 0U) const noexcept; - /// @brief finds the first occurence of the given character sequence; returns the position of the first character of - /// the found substring, returns iox::nullopt if no substring is found or if pos is greater than this' size + /// @brief finds the first occurrence of the given character sequence; returns the position of the first character + /// of the found substring, returns iox::nullopt if no substring is found or if pos is greater than this' size /// /// @param [in] str is the character sequence to search for; must be a iox::string, string literal or custom string /// @param [in] pos is the position at which to start the search @@ -483,7 +483,7 @@ class string final template IsStringOrCharArray> find(const T& str, const uint64_t pos = 0U) const noexcept; - /// @brief finds the first occurence of a character equal to one of the characters of the given character sequence + /// @brief finds the first occurrence of a character equal to one of the characters of the given character sequence /// and returns its position; returns iox::nullopt if no character is found or if pos is greater than this' /// size /// @@ -495,7 +495,7 @@ class string final template IsStringOrCharArray> find_first_of(const T& str, const uint64_t pos = 0U) const noexcept; - /// @brief finds the last occurence of a character equal to one of the characters of the given character sequence + /// @brief finds the last occurrence of a character equal to one of the characters of the given character sequence /// and returns its position; returns iox::nullopt if no character is found /// /// @param [in] str is the character sequence to search for; must be a iox::string, string literal or custom string diff --git a/iceoryx_hoofs/vocabulary/include/iox/variant.hpp b/iceoryx_hoofs/vocabulary/include/iox/variant.hpp index 1faf2fb0cf..1eb27a9768 100644 --- a/iceoryx_hoofs/vocabulary/include/iox/variant.hpp +++ b/iceoryx_hoofs/vocabulary/include/iox/variant.hpp @@ -63,7 +63,7 @@ struct in_place_type /// /// variant someVariant2(in_place_type, 12); /// -/// // variant with setted value therefore the index is not invalid +/// // variant with set value therefore the index is not invalid /// if ( someVariant.index() != INVALID_VARIANT_INDEX ) ... /// @endcode static constexpr uint64_t INVALID_VARIANT_INDEX{std::numeric_limits::max()}; diff --git a/iceoryx_platform/cmake/IceoryxPlatformSettings.cmake b/iceoryx_platform/cmake/IceoryxPlatformSettings.cmake index 14a2dc30b9..b65e75834a 100644 --- a/iceoryx_platform/cmake/IceoryxPlatformSettings.cmake +++ b/iceoryx_platform/cmake/IceoryxPlatformSettings.cmake @@ -15,7 +15,7 @@ # Dummy cmake file for source tree builds. The actual variables are sourced from # "IceoryxPlatformSettings.cmake" which resides either in the root path of the autodetected or -# user provided platorm. The out of tree build uses the installed copy of that file." +# user provided platform. The out of tree build uses the installed copy of that file." # # Example: # 1. "unix" is autodetected so the file "./unix/IceoryxPlatformSettings.cmake" is sourced diff --git a/iceoryx_platform/generic/include/iceoryx_platform/atomic.hpp b/iceoryx_platform/generic/include/iceoryx_platform/atomic.hpp index 6b7f65a525..986f7d0bdc 100644 --- a/iceoryx_platform/generic/include/iceoryx_platform/atomic.hpp +++ b/iceoryx_platform/generic/include/iceoryx_platform/atomic.hpp @@ -274,7 +274,7 @@ class Atomic return m_value.fetch_add(value, order); } - /// @brief Atomically substracts the given value to the stored value with the given memory order and returns the + /// @brief Atomically subtracts the given value to the stored value with the given memory order and returns the /// previous value template enable_if_integral_t fetch_sub(T value, std::memory_order order = std::memory_order_seq_cst) noexcept @@ -282,7 +282,7 @@ class Atomic return m_value.fetch_sub(value, order); } - /// @brief Atomically substracts the given value to the stored value with the given memory order and returns the + /// @brief Atomically subtracts the given value to the stored value with the given memory order and returns the /// previous value template enable_if_integral_t fetch_sub(T value, std::memory_order order = std::memory_order_seq_cst) volatile noexcept @@ -290,7 +290,7 @@ class Atomic return m_value.fetch_sub(value, order); } - /// @brie Atomically substracts the given difference to the stored pointer value with the given memory order and + /// @brie Atomically subtracts the given difference to the stored pointer value with the given memory order and /// returns the previous pointer value template enable_if_pointer_t fetch_sub(std::ptrdiff_t value, std::memory_order order = std::memory_order_seq_cst) noexcept @@ -298,7 +298,7 @@ class Atomic return m_value.fetch_sub(value, order); } - /// @brie Atomically substracts the given difference to the stored pointer value with the given memory order and + /// @brie Atomically subtracts the given difference to the stored pointer value with the given memory order and /// returns the previous pointer value template enable_if_pointer_t fetch_sub(std::ptrdiff_t value, @@ -323,7 +323,7 @@ class Atomic return m_value.operator+=(value); } - /// @brief Atomically substracts the given value to the stored value and returns the resulting value. Equivalent to + /// @brief Atomically subtracts the given value to the stored value and returns the resulting value. Equivalent to /// 'fetch_sub(value) - value' template enable_if_integral_t operator-=(T value) noexcept @@ -331,7 +331,7 @@ class Atomic return m_value.operator-=(value); } - /// @brief Atomically substracts the given value to the stored value and returns the resulting value. Equivalent to + /// @brief Atomically subtracts the given value to the stored value and returns the resulting value. Equivalent to /// 'fetch_sub(value) - value' template enable_if_integral_t operator-=(T value) volatile noexcept @@ -355,7 +355,7 @@ class Atomic return m_value.operator+=(value); } - /// @brief Atomically substracts the given difference to the stored pointer value and returns the resulting new + /// @brief Atomically subtracts the given difference to the stored pointer value and returns the resulting new /// pointer value. Equivalent to 'fetch_sub(value) - value' template enable_if_pointer_t operator-=(std::ptrdiff_t value) noexcept @@ -363,7 +363,7 @@ class Atomic return m_value.operator-=(value); } - /// @brief Atomically substracts the given difference to the stored pointer value and returns the resulting new + /// @brief Atomically subtracts the given difference to the stored pointer value and returns the resulting new /// pointer value. Equivalent to 'fetch_sub(value) - value' template enable_if_pointer_t operator-=(std::ptrdiff_t value) volatile noexcept diff --git a/iceoryx_platform/win/include/iceoryx_platform/signal.hpp b/iceoryx_platform/win/include/iceoryx_platform/signal.hpp index a52e3dd73e..dfc6c208d6 100644 --- a/iceoryx_platform/win/include/iceoryx_platform/signal.hpp +++ b/iceoryx_platform/win/include/iceoryx_platform/signal.hpp @@ -21,7 +21,7 @@ #include #define SIGEV_THREAD 0 -#define SIGBUS SIGSEGV // SIGBUS/SIGSEGV signal serious program erros, SIGSEGV is best alternative +#define SIGBUS SIGSEGV // SIGBUS/SIGSEGV signal serious program errors, SIGSEGV is best alternative #define SIGHUP SIGTERM // SIGHUP signaled when controlling terminal is closed, SIGTERM is best alternative #define SIGKILL 9 diff --git a/iceoryx_posh/include/iceoryx_posh/gateway/gateway_generic.hpp b/iceoryx_posh/include/iceoryx_posh/gateway/gateway_generic.hpp index 0e3f0ed444..6b18f76e20 100644 --- a/iceoryx_posh/include/iceoryx_posh/gateway/gateway_generic.hpp +++ b/iceoryx_posh/include/iceoryx_posh/gateway/gateway_generic.hpp @@ -83,7 +83,7 @@ class GatewayGeneric : public gateway_t virtual void discover(const capro::CaproMessage& msg) noexcept = 0; /// /// @brief forward Forward data between the two terminals of the channel used by the implementation. - /// @param channel The channel to propogate data across. + /// @param channel The channel to propagate data across. /// virtual void forward(const channel_t& channel) noexcept = 0; @@ -119,12 +119,12 @@ class GatewayGeneric : public gateway_t /// @brief findChannel Searches for a channel for the given service in the internally stored collection and returns /// it one exists. /// @param service The service to find a channel for. - /// @return An optional containining the matching channel if one exists, otherwise an empty optional. + /// @return An optional containing the matching channel if one exists, otherwise an empty optional. /// optional findChannel(const capro::ServiceDescription& service) const noexcept; /// - /// @brief forEachChannel Executs the given function for each channel in the internally stored collection. + /// @brief forEachChannel Executes the given function for each channel in the internally stored collection. /// @param f The function to execute. /// @note This operation allows thread-safe access to the internal collection. /// diff --git a/iceoryx_posh/include/iceoryx_posh/internal/popo/building_blocks/chunk_distributor.hpp b/iceoryx_posh/include/iceoryx_posh/internal/popo/building_blocks/chunk_distributor.hpp index f193c6205b..34835b4acf 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/popo/building_blocks/chunk_distributor.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/popo/building_blocks/chunk_distributor.hpp @@ -38,10 +38,10 @@ enum class ChunkDistributorError QUEUE_NOT_IN_CONTAINER }; -/// @brief The ChunkDistributor is the low layer building block to send SharedChunks to a dynamic number of ChunkQueus. +/// @brief The ChunkDistributor is the low layer building block to send SharedChunks to a dynamic number of ChunkQueues. /// Together with the ChunkQueuePusher, the ChunkDistributor builds the infrastructure to exchange memory chunks between /// different data producers and consumers that could be located in different processes. Besides a modifiable container -/// of ChunkQueues to which a SharedChunk can be deliverd, it holds a configurable history of last sent chunks. This +/// of ChunkQueues to which a SharedChunk can be delivered, it holds a configurable history of last sent chunks. This /// allows to provide a newly added queue a number of last chunks to start from. This is needed for functionality /// known as latched topic in ROS or field in ara::com. A ChunkDistributor is used to build elements of higher /// abstraction layers that also do memory managemet and provide an API towards the real user @@ -82,13 +82,13 @@ class ChunkDistributor /// @param[in] queueToAdd chunk queue to add to the list /// @param[in] requestedHistory number of last chunks from history to send if available. If history size is smaller /// then the available history size chunks are provided - /// @return if the queue could be added it returns success, otherwiese a ChunkDistributor error + /// @return if the queue could be added it returns success, otherwise a ChunkDistributor error expected tryAddQueue(not_null queueToAdd, const uint64_t requestedHistory = 0U) noexcept; /// @brief Remove a queue from the internal list of chunk queues /// @param[in] queueToRemove is the queue to remove from the list - /// @return if the queue could be removed it returns success, otherwiese a ChunkDistributor error + /// @return if the queue could be removed it returns success, otherwise a ChunkDistributor error expected tryRemoveQueue(not_null queueToRemove) noexcept; /// @brief Delete all the stored chunk queues diff --git a/iceoryx_posh/include/iceoryx_posh/internal/popo/building_blocks/chunk_queue_pusher.hpp b/iceoryx_posh/include/iceoryx_posh/internal/popo/building_blocks/chunk_queue_pusher.hpp index 56c32bd454..819dc2510e 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/popo/building_blocks/chunk_queue_pusher.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/popo/building_blocks/chunk_queue_pusher.hpp @@ -30,7 +30,7 @@ namespace popo /// @brief The ChunkQueuePusher is the low layer building block to push SharedChunks in a chunk queue. /// Together with the ChunkDistributor and ChunkQueuePopper the ChunkQueuePusher builds the infrastructure /// to exchange memory chunks between different data producers and consumers that could be located in different -/// processes. A ChunkQueuePusher is the part of the chunk queue that is knwon by the ChunkDistributor +/// processes. A ChunkQueuePusher is the part of the chunk queue that is known by the ChunkDistributor template class ChunkQueuePusher { diff --git a/iceoryx_posh/include/iceoryx_posh/internal/popo/building_blocks/chunk_receiver.hpp b/iceoryx_posh/include/iceoryx_posh/internal/popo/building_blocks/chunk_receiver.hpp index aaa244daa7..50ac8d6e47 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/popo/building_blocks/chunk_receiver.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/popo/building_blocks/chunk_receiver.hpp @@ -83,7 +83,7 @@ class ChunkReceiver : public ChunkQueuePopper tryGetPreviousChunk() const noexcept; /// @brief Release all the chunks that are currently held. Caution: Only call this if the user process is no more - /// running E.g. This cleans up chunks that were held by a user process that died unexpectetly, for avoiding lost + /// running E.g. This cleans up chunks that were held by a user process that died unexpectedly, for avoiding lost /// chunks in the system void releaseAll() noexcept; diff --git a/iceoryx_posh/include/iceoryx_posh/internal/popo/building_blocks/condition_notifier.hpp b/iceoryx_posh/include/iceoryx_posh/internal/popo/building_blocks/condition_notifier.hpp index e0b3e64130..1ef349dda2 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/popo/building_blocks/condition_notifier.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/popo/building_blocks/condition_notifier.hpp @@ -23,7 +23,7 @@ namespace iox { namespace popo { -/// @brief ConditionNotifier can notifiy waiting threads and processes using a shared memory condition variable +/// @brief ConditionNotifier can notify waiting threads and processes using a shared memory condition variable class ConditionNotifier { public: diff --git a/iceoryx_posh/include/iceoryx_posh/internal/popo/ports/client_port_user.hpp b/iceoryx_posh/include/iceoryx_posh/internal/popo/ports/client_port_user.hpp index d67ebff147..c918b651fa 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/popo/ports/client_port_user.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/popo/ports/client_port_user.hpp @@ -77,8 +77,8 @@ class ClientPortUser : public BasePort /// @brief Allocate a chunk, the ownerhip of the SharedChunk remains in the ClientPortUser for being able to /// cleanup if the user process disappears - /// @param[in] userPayloadSize, size of the user-paylaod without additional headers - /// @param[in] userPayloadAlignment, alignment of the user-paylaod without additional headers + /// @param[in] userPayloadSize, size of the user-payload without additional headers + /// @param[in] userPayloadAlignment, alignment of the user-payload without additional headers /// @return on success pointer to a RequestHeader which can be used to access the chunk-header, user-header and /// user-payload fields, error if not expected allocateRequest(const uint64_t userPayloadSize, diff --git a/iceoryx_posh/include/iceoryx_posh/internal/popo/ports/server_port_user.hpp b/iceoryx_posh/include/iceoryx_posh/internal/popo/ports/server_port_user.hpp index 9ace7765fc..59a7241973 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/popo/ports/server_port_user.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/popo/ports/server_port_user.hpp @@ -130,8 +130,8 @@ class ServerPortUser : public BasePort /// @brief Allocate a response, the ownerhip of the SharedChunk remains in the ServerPortUser for being able to /// cleanup if the user process disappears /// @param[in] requestHeader, the request header for the corresponding response - /// @param[in] userPayloadSize, size of the user user-paylaod without additional headers - /// @param[in] userPayloadAlignment, alignment of the user user-paylaod without additional headers + /// @param[in] userPayloadSize, size of the user user-payload without additional headers + /// @param[in] userPayloadAlignment, alignment of the user user-payload without additional headers /// @return on success pointer to a ChunkHeader which can be used to access the chunk-header, user-header and /// user-payload fields, error if not expected allocateResponse(const RequestHeader* const requestHeader, diff --git a/iceoryx_posh/include/iceoryx_posh/internal/popo/ports/subscriber_port_multi_producer.hpp b/iceoryx_posh/include/iceoryx_posh/internal/popo/ports/subscriber_port_multi_producer.hpp index 7498ae2bd5..8fd2b71559 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/popo/ports/subscriber_port_multi_producer.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/popo/ports/subscriber_port_multi_producer.hpp @@ -43,7 +43,7 @@ class SubscriberPortMultiProducer : public SubscriberPortRouDi ~SubscriberPortMultiProducer() = default; /// @brief get an optional CaPro message that changes the subscription state of the subscriber - /// @return CaPro message with new subscription requet, empty optional if no state change + /// @return CaPro message with new subscription request, empty optional if no state change optional tryGetCaProMessage() noexcept override; /// @brief dispatch a CaPro message to the subscriber for processing diff --git a/iceoryx_posh/include/iceoryx_posh/internal/popo/ports/subscriber_port_roudi.hpp b/iceoryx_posh/include/iceoryx_posh/internal/popo/ports/subscriber_port_roudi.hpp index 4972e8563d..ef52c46ad7 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/popo/ports/subscriber_port_roudi.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/popo/ports/subscriber_port_roudi.hpp @@ -30,7 +30,7 @@ namespace iox namespace popo { /// @brief The SubscriberPortRouDi provides the API for accessing a subscriber port from the RouDi middleware daemon -/// side. The subscriber port is divided in the sevaral parts like SubscriberPortData, SubscriberPortRouDi and +/// side. The subscriber port is divided in the several parts like SubscriberPortData, SubscriberPortRouDi and /// SubscriberPortUser. The SubscriberPortRouDi provides service discovery functionality that is based on CaPro /// messages. With this API the dynamic connections between publisher and subscriber ports can be established class SubscriberPortRouDi : public BasePort @@ -51,7 +51,7 @@ class SubscriberPortRouDi : public BasePort const SubscriberOptions& getOptions() const noexcept; /// @brief get an optional CaPro message that requests changes to the subscription state of the subscriber - /// @return CaPro message with new subscription requet, empty optional if no state change + /// @return CaPro message with new subscription request, empty optional if no state change virtual optional tryGetCaProMessage() noexcept = 0; /// @brief dispatch a CaPro message to the subscriber for processing diff --git a/iceoryx_posh/include/iceoryx_posh/internal/popo/ports/subscriber_port_single_producer.hpp b/iceoryx_posh/include/iceoryx_posh/internal/popo/ports/subscriber_port_single_producer.hpp index abd4336e17..f3ef085bc7 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/popo/ports/subscriber_port_single_producer.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/popo/ports/subscriber_port_single_producer.hpp @@ -43,7 +43,7 @@ class SubscriberPortSingleProducer : public SubscriberPortRouDi ~SubscriberPortSingleProducer() = default; /// @brief get an optional CaPro message that changes the subscription state of the subscriber - /// @return CaPro message with new subscription requet, empty optional if no state change + /// @return CaPro message with new subscription request, empty optional if no state change optional tryGetCaProMessage() noexcept override; /// @brief dispatch a CaPro message to the subscriber for processing diff --git a/iceoryx_posh/include/iceoryx_posh/internal/popo/publisher_impl.hpp b/iceoryx_posh/include/iceoryx_posh/internal/popo/publisher_impl.hpp index 1d1a595428..5e606fb6e5 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/popo/publisher_impl.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/popo/publisher_impl.hpp @@ -48,7 +48,7 @@ class PublisherImpl : public BasePublisherType, private PublisherInterface PublisherImpl& operator=(PublisherImpl&& rhs) noexcept = delete; /// - /// @brief loan Get a sample from loaned shared memory and consctruct the data with the given arguments. + /// @brief loan Get a sample from loaned shared memory and construct the data with the given arguments. /// @param args Arguments used to construct the data. /// @return An instance of the sample that resides in shared memory or an error if unable ot allocate memory to /// loan. diff --git a/iceoryx_posh/include/iceoryx_posh/internal/popo/publisher_impl.inl b/iceoryx_posh/include/iceoryx_posh/internal/popo/publisher_impl.inl index 7278fdc7db..e2f3dd285b 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/popo/publisher_impl.inl +++ b/iceoryx_posh/include/iceoryx_posh/internal/popo/publisher_impl.inl @@ -68,7 +68,7 @@ template inline expected PublisherImpl::publishCopyOf(const T& val) noexcept { return loanSample().and_then([&](auto& sample) { - new (sample.get()) T(val); // Placement new copy-construction of sample, avoid copy-assigment because there + new (sample.get()) T(val); // Placement new copy-construction of sample, avoid copy-assignment because there // might not be an existing instance of T in the sample memory sample.publish(); }); diff --git a/iceoryx_posh/include/iceoryx_posh/internal/popo/server_impl.hpp b/iceoryx_posh/include/iceoryx_posh/internal/popo/server_impl.hpp index 8f27d3d043..7dab120e7f 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/popo/server_impl.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/popo/server_impl.hpp @@ -40,7 +40,7 @@ class ServerImpl : public BaseServerT, private RpcInterface, Serve using ResponseTypeAssert = typename TypedPortApiTrait::Assert; public: - /// @brief Constructor for a sserver + /// @brief Constructor for a server /// @param[in] service is the ServiceDescription for the new server /// @param[in] serverOptions like the queue capacity and queue full policy by a server explicit ServerImpl(const capro::ServiceDescription& service, const ServerOptions& serverOptions = {}) noexcept; diff --git a/iceoryx_posh/include/iceoryx_posh/internal/roudi/process_manager.hpp b/iceoryx_posh/include/iceoryx_posh/internal/roudi/process_manager.hpp index a947f47980..9f5e840907 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/roudi/process_manager.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/roudi/process_manager.hpp @@ -180,14 +180,14 @@ class ProcessManager : public ProcessManagerInterface /// @brief Removes the process from the managed client process list, identified by its id. /// @param [in] name The process name which should be removed. - /// @param [in] sendAckToProcess Informs process that the termination messsage was received + /// @param [in] sendAckToProcess Informs process that the termination message was received /// @return Returns true if the process was found and removed from the internal list. bool searchForProcessAndRemoveIt(const RuntimeName_t& name, const TerminationFeedback feedback) noexcept; /// @brief Removes the given process from the managed client process list and the respective resources in shared /// memory /// @param [in] processIter The process which should be removed. - /// @param [in] sendAckToProcess Informs process that the termination messsage was received + /// @param [in] sendAckToProcess Informs process that the termination message was received /// @return Returns true if the process was found and removed from the internal list. bool removeProcessAndDeleteRespectiveSharedMemoryObjects(ProcessList_t::iterator& processIter, const TerminationFeedback feedback) noexcept; diff --git a/iceoryx_posh/include/iceoryx_posh/internal/roudi/service_registry.hpp b/iceoryx_posh/include/iceoryx_posh/internal/roudi/service_registry.hpp index fd4776abcb..7f0938eec5 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/roudi/service_registry.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/roudi/service_registry.hpp @@ -77,7 +77,7 @@ class ServiceRegistry void removeServer(const capro::ServiceDescription& serviceDescription) noexcept; /// @brief Removes given service description from registry if service is found, - /// all occurences are removed + /// all occurrences are removed /// @param[in] serviceDescription, service to be removed void purge(const capro::ServiceDescription& serviceDescription) noexcept; diff --git a/iceoryx_posh/include/iceoryx_posh/internal/runtime/ipc_interface_base.hpp b/iceoryx_posh/include/iceoryx_posh/internal/runtime/ipc_interface_base.hpp index 9c29a9cc2a..f0f8ba678c 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/runtime/ipc_interface_base.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/runtime/ipc_interface_base.hpp @@ -175,7 +175,7 @@ class IpcInterface /// @param[in] timeout for receiving a message. /// @param[in] answer The answer of the IPC channel. If timedReceive /// failed the content of answer is undefined. - /// @return If a valid message was received before the timeout occures + /// @return If a valid message was received before the timeout occurs /// it returns true, otherwise false. /// It also returns false if clock_gettime() failed bool timedReceive(const units::Duration timeout, IpcMessage& answer) const noexcept; @@ -212,7 +212,7 @@ class IpcInterface /// @return initialization state bool isInitialized() const noexcept; - /// @brief Since there might be an outdated IPC channel due to an unclean temination + /// @brief Since there might be an outdated IPC channel due to an unclean termination /// this function closes the IPC channel if it's existing. /// @param[in] name of the IPC channel to clean up static void cleanupOutdatedIpcChannel(const InterfaceName_t& name) noexcept; @@ -223,13 +223,13 @@ class IpcInterface protected: /// @brief Closes and opens an existing IPC channel using the same parameters as before. - /// If the queue was not open, it is just openened. + /// If the queue was not open, it is just opened. /// @return true if successfully reopened, false if not bool reopen() noexcept; /// @brief Checks if the IPC channel has its counterpart in the file system /// @return If the IPC channel, which corresponds to a descriptor, - /// is still availabe in the file system it returns true, + /// is still available in the file system it returns true, /// otherwise it was deleted or the IPC channel was not open and returns false bool ipcChannelMapsToFile() noexcept; diff --git a/iceoryx_posh/include/iceoryx_posh/internal/runtime/ipc_message.hpp b/iceoryx_posh/include/iceoryx_posh/internal/runtime/ipc_message.hpp index 085b1e008d..3bb2bdd039 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/runtime/ipc_message.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/runtime/ipc_message.hpp @@ -59,13 +59,13 @@ class IpcMessage /// @brief Adds a new entry to the IpcMessage, if the entry is invalid /// no entry is added and the IpcMessage becomes invalid. - /// @param[in] entry Datatype which is convertable to string via std::to_string + /// @param[in] entry Datatype which is convertible to string via std::to_string template IpcMessage& operator<<(const T& entry) noexcept; /// @brief Returns the number of entries stored in IpcMessage. /// If the message is invalid the return value is undefined. - /// @return number of entries in messaage + /// @return number of entries in message uint32_t getNumberOfElements() const noexcept; /// @brief Returns the entry at position f_index. If f_index is larger @@ -108,7 +108,7 @@ class IpcMessage /// @brief Adds a new entry to the IpcMessage, if the entry is invalid /// no entry is added and the IpcMessage becomes invalid. - /// @tparam Datatype which is convertable to string via + /// @tparam Datatype which is convertible to string via /// std::stringstream /// @param[in] entry to add to the message template diff --git a/iceoryx_posh/include/iceoryx_posh/internal/runtime/ipc_runtime_interface.hpp b/iceoryx_posh/include/iceoryx_posh/internal/runtime/ipc_runtime_interface.hpp index 7387b9a84d..32099e2139 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/runtime/ipc_runtime_interface.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/runtime/ipc_runtime_interface.hpp @@ -64,7 +64,7 @@ class IpcRuntimeInterface IpcMessage& answer, iox::optional timeout = iox::nullopt) noexcept; - /// @brief get the adress offset of the segment manager + /// @brief get the address offset of the segment manager /// @return address offset as iox::RelativePointer::offset_t UntypedRelativePointer::offset_t getSegmentManagerAddressOffset() const noexcept; diff --git a/iceoryx_posh/include/iceoryx_posh/internal/runtime/shared_memory_user.hpp b/iceoryx_posh/include/iceoryx_posh/internal/runtime/shared_memory_user.hpp index 33284e9121..8bdf7cdd63 100644 --- a/iceoryx_posh/include/iceoryx_posh/internal/runtime/shared_memory_user.hpp +++ b/iceoryx_posh/include/iceoryx_posh/internal/runtime/shared_memory_user.hpp @@ -49,7 +49,7 @@ class SharedMemoryUser /// @param[in] domainId to tie the shared memory to /// @param[in] segmentId of the segment for the relocatable shared memory segment address space /// @param[in] managementShmSize size of the shared memory management segment - /// @param[in] segmentManagerAddressOffset adress of the segment manager that does the final mapping of memory in + /// @param[in] segmentManagerAddressOffset address of the segment manager that does the final mapping of memory in /// the process /// @return a 'SharedMemoryUser' instance or an 'SharedMemoryUserError' on failure static expected diff --git a/iceoryx_posh/include/iceoryx_posh/popo/trigger_handle.hpp b/iceoryx_posh/include/iceoryx_posh/popo/trigger_handle.hpp index b7669164ee..fa3e0dff2c 100644 --- a/iceoryx_posh/include/iceoryx_posh/popo/trigger_handle.hpp +++ b/iceoryx_posh/include/iceoryx_posh/popo/trigger_handle.hpp @@ -29,10 +29,10 @@ namespace popo { /// @brief TriggerHandle is threadsafe without restrictions in a single process. /// Not qualified for inter process usage. The TriggerHandle is generated -/// by a Notifyable like the WaitSet and handed out to the user when they +/// by a Notifiable like the WaitSet and handed out to the user when they /// acquire a trigger. The TriggerHandle corresponds with an internal Trigger /// and is used to signal an event via the trigger method. When it goes -/// out of scope it cleans up the corresponding trigger in the Notifyable. +/// out of scope it cleans up the corresponding trigger in the Notifiable. class TriggerHandle { public: @@ -43,7 +43,7 @@ class TriggerHandle /// @param[in] conditionVariableDataRef reference to a condition variable data struct /// @param[in] resetCallback callback which will be called it goes out of scope or reset is called /// @param[in] uniqueTriggerId the unique trigger id of the Trigger which corresponds to the TriggerHandle. Usually - /// stored in a Notifyable. It is required for the resetCallback + /// stored in a Notifiable. It is required for the resetCallback TriggerHandle(ConditionVariableData& conditionVariableData, const function& resetCallback, const uint64_t uniqueTriggerId) noexcept; @@ -67,7 +67,7 @@ class TriggerHandle /// all events. bool wasTriggered() const noexcept; - /// @brief triggers the Trigger and informs the Notifyable which verifies that the Trigger was triggered by calling + /// @brief triggers the Trigger and informs the Notifiable which verifies that the Trigger was triggered by calling /// the hasTriggeredCallback void trigger() noexcept; diff --git a/iceoryx_posh/include/iceoryx_posh/runtime/posh_runtime.hpp b/iceoryx_posh/include/iceoryx_posh/runtime/posh_runtime.hpp index 8309d7ce90..a9012dbe00 100644 --- a/iceoryx_posh/include/iceoryx_posh/runtime/posh_runtime.hpp +++ b/iceoryx_posh/include/iceoryx_posh/runtime/posh_runtime.hpp @@ -147,7 +147,7 @@ class PoshRuntime /// @param[in] msg request message to send /// @param[out] response from the RouDi daemon /// @param[in] timeout receive timeout, default disabled - /// @return true if sucessful request/response, false on error + /// @return true if successful request/response, false on error virtual bool sendRequestToRouDi(const IpcMessage& msg, IpcMessage& answer, iox::optional timeout = iox::nullopt) noexcept = 0; diff --git a/iceoryx_posh/source/mepoo/mepoo_config.cpp b/iceoryx_posh/source/mepoo/mepoo_config.cpp index a225bf2a3c..6845540e93 100644 --- a/iceoryx_posh/source/mepoo/mepoo_config.cpp +++ b/iceoryx_posh/source/mepoo/mepoo_config.cpp @@ -36,7 +36,7 @@ void MePooConfig::addMemPool(MePooConfig::Entry entry) noexcept } else { - IOX_LOG(Fatal, "Maxmimum number of mempools reached, no more mempools available"); + IOX_LOG(Fatal, "Maximum number of mempools reached, no more mempools available"); IOX_REPORT_FATAL(PoshError::MEPOO__MAXIMUM_NUMBER_OF_MEMPOOLS_REACHED); } } diff --git a/iceoryx_posh/source/mepoo/shm_safe_unmanaged_chunk.cpp b/iceoryx_posh/source/mepoo/shm_safe_unmanaged_chunk.cpp index 32116ac622..7617ce7375 100644 --- a/iceoryx_posh/source/mepoo/shm_safe_unmanaged_chunk.cpp +++ b/iceoryx_posh/source/mepoo/shm_safe_unmanaged_chunk.cpp @@ -32,7 +32,7 @@ static_assert(sizeof(ShmSafeUnmanagedChunk) <= 8U, static_assert(sizeof(ShmSafeUnmanagedChunk) == alignof(ShmSafeUnmanagedChunk), "A ShmSafeUnmanagedChunk must be placed on an address which does not cross the native alignment!"); // This is important for the use in the SOFI where under some conditions the copy operation could work on partially -// obsolet data and therefore non-trivial copy ctor/assignment operator or dtor would work on corrupted data. +// obsolete data and therefore non-trivial copy ctor/assignment operator or dtor would work on corrupted data. static_assert(std::is_trivially_copyable::value, "The ShmSafeUnmanagedChunk must be trivially copyable to prevent Frankenstein objects when the copy ctor " "works on half dead objects!"); diff --git a/iceoryx_posh/source/roudi/iceoryx_roudi_components.cpp b/iceoryx_posh/source/roudi/iceoryx_roudi_components.cpp index aa1ca6a015..46ec079e6f 100644 --- a/iceoryx_posh/source/roudi/iceoryx_roudi_components.cpp +++ b/iceoryx_posh/source/roudi/iceoryx_roudi_components.cpp @@ -26,7 +26,7 @@ IceOryxRouDiComponents::IceOryxRouDiComponents(const IceoryxConfig& config) noex : rouDiMemoryManager(config) , portManager([&]() -> IceOryxRouDiMemoryManager* { // this temporary object will create a roudi IPC channel - // and close it immediatelly + // and close it immediately // if there was an outdated roudi IPC channel, it will be cleaned up // if there is an outdated IPC channel, the start of the apps will be terminated runtime::IpcInterfaceBase::cleanupOutdatedIpcChannel(roudi::IPC_CHANNEL_ROUDI_NAME); diff --git a/iceoryx_posh/source/roudi/port_manager.cpp b/iceoryx_posh/source/roudi/port_manager.cpp index 1291567e8a..c520d0b9eb 100644 --- a/iceoryx_posh/source/roudi/port_manager.cpp +++ b/iceoryx_posh/source/roudi/port_manager.cpp @@ -278,7 +278,7 @@ void PortManager::handleClientPorts() noexcept doDiscoveryForClientPort(clientPort); - // check if we have to destroy this clinet port + // check if we have to destroy this client port if (clientPort.toBeDestroyed()) { destroyClientPort(currentPort.to_ptr()); @@ -387,7 +387,7 @@ void PortManager::handleServerPorts() noexcept void PortManager::doDiscoveryForServerPort(popo::ServerPortRouDi& serverPort) noexcept { serverPort.tryGetCaProMessage().and_then([this, &serverPort](auto caproMessage) { - /// @todo iox-#1128 report to port instrospection + /// @todo iox-#1128 report to port introspection if (capro::CaproMessageType::OFFER == caproMessage.m_type) { diff --git a/iceoryx_posh/source/roudi/process_manager.cpp b/iceoryx_posh/source/roudi/process_manager.cpp index 48406c506a..b1c2f0a19c 100644 --- a/iceoryx_posh/source/roudi/process_manager.cpp +++ b/iceoryx_posh/source/roudi/process_manager.cpp @@ -63,7 +63,7 @@ ProcessManager::ProcessManager(RouDiMemoryInterface& roudiMemoryInterface, auto maybeIntrospectionMemoryManager = m_roudiMemoryInterface.introspectionMemoryManager(); if (!maybeIntrospectionMemoryManager.has_value()) { - IOX_LOG(Fatal, "Invalid state! Could not obtain MemoryManager for instrospection!"); + IOX_LOG(Fatal, "Invalid state! Could not obtain MemoryManager for introspection!"); fatalError = true; } else diff --git a/iceoryx_posh/source/roudi/roudi.cpp b/iceoryx_posh/source/roudi/roudi.cpp index 651adae2bf..58b3c1b628 100644 --- a/iceoryx_posh/source/roudi/roudi.cpp +++ b/iceoryx_posh/source/roudi/roudi.cpp @@ -52,7 +52,7 @@ RouDi::RouDi(RouDiMemoryInterface& roudiMemoryInterface, { if (detail::isCompiledOn32BitSystem()) { - IOX_LOG(Warn, "Runnning RouDi on 32-bit architectures is experimental! Use at your own risk!"); + IOX_LOG(Warn, "Running RouDi on 32-bit architectures is experimental! Use at your own risk!"); } m_processIntrospection.registerPublisherPort( PublisherPortUserType(m_prcMgr->addIntrospectionPublisherPort(IntrospectionProcessService))); diff --git a/iceoryx_posh/source/roudi/service_registry.cpp b/iceoryx_posh/source/roudi/service_registry.cpp index 08d9d6ebf6..edd1421142 100644 --- a/iceoryx_posh/source/roudi/service_registry.cpp +++ b/iceoryx_posh/source/roudi/service_registry.cpp @@ -32,7 +32,7 @@ expected ServiceRegistry::add(const capro::Service auto index = findIndex(serviceDescription); if (index != NO_INDEX) { - // multiple entries with the same service descripion are possible + // multiple entries with the same service description are possible // and we just increase the count in this case (multi-set semantics) // entry exists, increment counter auto& entry = m_serviceDescriptions[index]; diff --git a/iceoryx_posh/source/runtime/heartbeat.cpp b/iceoryx_posh/source/runtime/heartbeat.cpp index 18345deee0..f7b66638d6 100644 --- a/iceoryx_posh/source/runtime/heartbeat.cpp +++ b/iceoryx_posh/source/runtime/heartbeat.cpp @@ -55,7 +55,7 @@ uint64_t Heartbeat::milliseconds_since_epoch() noexcept IOX_ENFORCE( !IOX_POSIX_CALL(iox_clock_gettime)(CLOCK_MONOTONIC, &timepoint).failureReturnValue(-1).evaluate().has_error(), - "An error which should never happen occured during 'iox_clock_gettime'!"); + "An error which should never happen occurred during 'iox_clock_gettime'!"); return units::Duration(timepoint).toMilliseconds(); } diff --git a/iceoryx_posh/test/integrationtests/test_mq_interface_startup_race.cpp b/iceoryx_posh/test/integrationtests/test_mq_interface_startup_race.cpp index 6230e7458d..f87fe19667 100644 --- a/iceoryx_posh/test/integrationtests/test_mq_interface_startup_race.cpp +++ b/iceoryx_posh/test/integrationtests/test_mq_interface_startup_race.cpp @@ -132,7 +132,7 @@ TEST_F(CMqInterfaceStartupRace_test, ObsoleteRouDiMq) ::testing::Test::RecordProperty("TEST_ID", "a94080de-e07d-433b-be0d-6ca748006664"); GTEST_SKIP() << "@todo iox-#1106 Test is not compatible on all platforms and needs to be refactored or removed"; /// @note this test checks if the application handles the situation when the roudi mqueue was not properly cleaned - /// up and tries to use the obsolet mqueue while RouDi gets restarted and cleans its resources up and creates a new + /// up and tries to use the obsolete mqueue while RouDi gets restarted and cleans its resources up and creates a new /// mqueue iox::concurrent::Atomic shutdown; @@ -184,7 +184,7 @@ TEST_F(CMqInterfaceStartupRace_test, ObsoleteRouDiMqWithFullMq) ::testing::Test::RecordProperty("TEST_ID", "e7594a83-d0d1-49fb-8882-9d4dcc0372ef"); GTEST_SKIP() << "@todo iox-#1106 Test is not compatible on all platforms and needs to be refactored or removed"; /// @note this test checks if the application handles the situation when the roudi mqueue was not properly cleaned - /// up and tries to use the obsolet mqueue while RouDi gets restarted and cleans its resources up and creates a new + /// up and tries to use the obsolete mqueue while RouDi gets restarted and cleans its resources up and creates a new /// mqueue, the obsolete mqueue was filled up to the max message size, e.g. by the KEEP_ALIVE messages iox::concurrent::Atomic shutdown; diff --git a/iceoryx_posh/test/moduletests/test_roudi_process_introspection.cpp b/iceoryx_posh/test/moduletests/test_roudi_process_introspection.cpp index 86cb3d2639..946ccf1891 100644 --- a/iceoryx_posh/test/moduletests/test_roudi_process_introspection.cpp +++ b/iceoryx_posh/test/moduletests/test_roudi_process_introspection.cpp @@ -141,7 +141,7 @@ TEST_F(ProcessIntrospection_test, addRemoveProcess) ASSERT_THAT(chunk3, Ne(nullptr)); EXPECT_THAT(chunk3->sample()->m_processList.size(), Eq(0U)); - // if there isn't any change, no data are deliverd + // if there isn't any change, no data are delivered EXPECT_CALL(introspectionAccess->getPublisherPort().value(), sendChunk(_)).Times(0); EXPECT_CALL(introspectionAccess->getPublisherPort().value(), stopOffer()).Times(1); introspectionAccess->send(); diff --git a/iceoryx_posh/test/moduletests/test_roudi_service_registry.cpp b/iceoryx_posh/test/moduletests/test_roudi_service_registry.cpp index 5c92079544..57ecc21e78 100644 --- a/iceoryx_posh/test/moduletests/test_roudi_service_registry.cpp +++ b/iceoryx_posh/test/moduletests/test_roudi_service_registry.cpp @@ -627,7 +627,7 @@ TYPED_TEST(ServiceRegistry_test, SearchInFullRegistryWorks) // This is close to a worst case search but not quite due to randomness in the last string. // Different strings are required as we need different strings to create a full registry, // and randomness is the easiest way to achieve this. - // It could also be achieved with determinstic string enumeration instead of randomness, + // It could also be achieved with deterministic string enumeration instead of randomness, // but it is more cumbersome and not required here. this->find(service, instance, event); diff --git a/iceoryx_posh/test/moduletests/test_runtime_ipc_interface.cpp b/iceoryx_posh/test/moduletests/test_runtime_ipc_interface.cpp index 06b410878d..0e71952899 100644 --- a/iceoryx_posh/test/moduletests/test_runtime_ipc_interface.cpp +++ b/iceoryx_posh/test/moduletests/test_runtime_ipc_interface.cpp @@ -319,7 +319,7 @@ TYPED_TEST(IpcInterface_test, TimedReceiveWorks) using namespace std::chrono; runtime::IpcMessage msg; - msg << "very useful text for tranmission"; + msg << "very useful text for transmission"; Duration timeout = 100_ms; ASSERT_TRUE(this->client->send(msg)); diff --git a/tools/git-hooks/prepare-commit-msg b/tools/git-hooks/prepare-commit-msg index 6c1e727bbe..edc143c901 100755 --- a/tools/git-hooks/prepare-commit-msg +++ b/tools/git-hooks/prepare-commit-msg @@ -30,7 +30,7 @@ if [[ "$branch_name" =~ ^iox-[0-9]+ ]]; then elif [[ "$branch_name" =~ ^iox-#[0-9]+ ]]; then branch_issue_number="$(echo "$branch_name" | grep -Eo 'iox-#[0-9]+' | grep -Eo '[0-9]+')" echo -e "$COLOR_YELLOW" - echo -e "Warning: The branch name uses an obsolet convention with a hash in front of the issue number." + echo -e "Warning: The branch name uses an obsolete convention with a hash in front of the issue number." echo -e "Please don't use this pattern in the future!" echo -e "$COLOR_RESET" else diff --git a/tools/run_tests.sh b/tools/run_tests.sh index 1d4f103d99..5985cabf1d 100755 --- a/tools/run_tests.sh +++ b/tools/run_tests.sh @@ -88,7 +88,7 @@ for arg in "$@"; do echo " [all, unit, integration] Testlevel where the test shall run" echo " only-timing-tests Runs only timing tests" echo " continue-on-error Continue execution upon error" - echo " asan-only Execute Adress-Sanitizer only" + echo " asan-only Execute Address-Sanitizer only" echo " tsan-only Execute Thread-Sanitizer only" echo "" exit 1