From 78053b509a256497502db25d331f6ce02d423481 Mon Sep 17 00:00:00 2001 From: Pisit Sawangvonganan Date: Sun, 14 Jan 2024 16:13:34 +0700 Subject: [PATCH] etl: apply code spell check across entire code base Utilized a spell checking tool to identify and correct spelling throughout all files in the code base. Signed-off-by: Pisit Sawangvonganan --- cmake/GetGitRevisionDescription.cmake | 2 +- .../FunctionInterruptSimulation.cpp | 2 +- .../FunctionInterruptSimulation.cpp | 2 +- include/etl/algorithm.h | 2 +- include/etl/basic_string.h | 2 +- include/etl/bit_stream.h | 4 ++-- include/etl/byte_stream.h | 4 ++-- include/etl/fsm.h | 2 +- include/etl/generators/fsm_generator.h | 2 +- .../etl/generators/type_traits_generator.h | 2 +- include/etl/private/ivectorpointer.h | 4 ++-- include/etl/private/variant_variadic.h | 22 +++++++++---------- include/etl/span.h | 2 +- include/etl/to_arithmetic.h | 2 +- include/etl/type_traits.h | 2 +- include/etl/unordered_map.h | 2 +- include/etl/unordered_multimap.h | 2 +- include/etl/unordered_multiset.h | 2 +- include/etl/unordered_set.h | 2 +- support/Release notes.txt | 18 +++++++-------- test/test_multimap.cpp | 2 +- test/test_multiset.cpp | 2 +- 22 files changed, 43 insertions(+), 43 deletions(-) diff --git a/cmake/GetGitRevisionDescription.cmake b/cmake/GetGitRevisionDescription.cmake index 0a2035026..07ec5fafb 100644 --- a/cmake/GetGitRevisionDescription.cmake +++ b/cmake/GetGitRevisionDescription.cmake @@ -59,7 +59,7 @@ get_filename_component(_gitdescmoddir ${CMAKE_CURRENT_LIST_FILE} PATH) # function returns an empty string via _git_dir_var. # # Example: Given a path C:/bla/foo/bar and assuming C:/bla/.git exists and -# neither foo nor bar contain a file/directory .git. This wil return +# neither foo nor bar contain a file/directory .git. This will return # C:/bla/.git # function(_git_find_closest_git_dir _start_dir _git_dir_var) diff --git a/examples/FunctionInterruptSimulation-Delegates/FunctionInterruptSimulation.cpp b/examples/FunctionInterruptSimulation-Delegates/FunctionInterruptSimulation.cpp index 2fb61c92e..bbf6debf8 100644 --- a/examples/FunctionInterruptSimulation-Delegates/FunctionInterruptSimulation.cpp +++ b/examples/FunctionInterruptSimulation-Delegates/FunctionInterruptSimulation.cpp @@ -119,7 +119,7 @@ Uart uart1(0, USART1_IRQ_HANDLER); Uart uart2(1, USART2_IRQ_HANDLER); // Declare a global callback for the timer. -// Uses the most efficient callback type for a class, as everthing is known at compile time. +// Uses the most efficient callback type for a class, as everything is known at compile time. etl::delegate timer_member_callback = etl::delegate::create(); // Declare the callbacks for the free functions. diff --git a/examples/FunctionInterruptSimulation/FunctionInterruptSimulation.cpp b/examples/FunctionInterruptSimulation/FunctionInterruptSimulation.cpp index cee738775..9eb6cb98c 100644 --- a/examples/FunctionInterruptSimulation/FunctionInterruptSimulation.cpp +++ b/examples/FunctionInterruptSimulation/FunctionInterruptSimulation.cpp @@ -119,7 +119,7 @@ Uart uart1(0, USART1_IRQ_HANDLER); Uart uart2(1, USART2_IRQ_HANDLER); // Declare a global callback for the timer. -// Uses the most efficient callback type for a class, as everthing is known at compile time. +// Uses the most efficient callback type for a class, as everything is known at compile time. etl::function_imp timer_member_callback; // Declare the callbacks for the free functions. diff --git a/include/etl/algorithm.h b/include/etl/algorithm.h index cc989d153..efc5b8018 100644 --- a/include/etl/algorithm.h +++ b/include/etl/algorithm.h @@ -2177,7 +2177,7 @@ namespace etl //*************************************************************************** /// copy_if /// A safer form of copy_if where it terminates when the first end iterator is reached. - /// There is currently no STL equivelent. + /// There is currently no STL equivalent. ///\ingroup algorithm //*************************************************************************** template & erase(size_type position, size_type length_ = npos) { diff --git a/include/etl/bit_stream.h b/include/etl/bit_stream.h index 6dcc50f73..7c5b557ef 100644 --- a/include/etl/bit_stream.h +++ b/include/etl/bit_stream.h @@ -861,7 +861,7 @@ namespace etl } //*************************************************************************** - /// Sets the function to call afer every write. + /// Sets the function to call after every write. //*************************************************************************** void set_callback(callback_type callback_) { @@ -869,7 +869,7 @@ namespace etl } //*************************************************************************** - /// Gets the function to call afer every write. + /// Gets the function to call after every write. //*************************************************************************** callback_type get_callback() const { diff --git a/include/etl/byte_stream.h b/include/etl/byte_stream.h index aaa9d8a4b..4d0242fa5 100644 --- a/include/etl/byte_stream.h +++ b/include/etl/byte_stream.h @@ -410,7 +410,7 @@ namespace etl } //*************************************************************************** - /// Sets the function to call afer every write. + /// Sets the function to call after every write. //*************************************************************************** void set_callback(callback_type callback_) { @@ -418,7 +418,7 @@ namespace etl } //*************************************************************************** - /// Gets the function to call afer every write. + /// Gets the function to call after every write. //*************************************************************************** callback_type get_callback() const { diff --git a/include/etl/fsm.h b/include/etl/fsm.h index 19584a911..944758911 100644 --- a/include/etl/fsm.h +++ b/include/etl/fsm.h @@ -158,7 +158,7 @@ namespace etl }; //*************************************************************************** - /// Exception for forbidden state chages. + /// Exception for forbidden state changes. //*************************************************************************** class fsm_state_composite_state_change_forbidden : public etl::fsm_exception { diff --git a/include/etl/generators/fsm_generator.h b/include/etl/generators/fsm_generator.h index a59d1fa1f..6b6e5ef05 100644 --- a/include/etl/generators/fsm_generator.h +++ b/include/etl/generators/fsm_generator.h @@ -177,7 +177,7 @@ namespace etl }; //*************************************************************************** - /// Exception for forbidden state chages. + /// Exception for forbidden state changes. //*************************************************************************** class fsm_state_composite_state_change_forbidden : public etl::fsm_exception { diff --git a/include/etl/generators/type_traits_generator.h b/include/etl/generators/type_traits_generator.h index d2cf8ce63..c94b90e77 100644 --- a/include/etl/generators/type_traits_generator.h +++ b/include/etl/generators/type_traits_generator.h @@ -74,7 +74,7 @@ cog.outl("//******************************************************************** ///\defgroup type_traits type_traits /// A set of type traits definitions. -/// Derived from either the standard or alternate definitions, dependant on whether or not ETL_NO_STL is defined. +/// Derived from either the standard or alternate definitions, dependent on whether or not ETL_NO_STL is defined. /// \ingroup utilities #if ETL_USING_STL && ETL_USING_CPP11 diff --git a/include/etl/private/ivectorpointer.h b/include/etl/private/ivectorpointer.h index 52b9924ca..52f938fe3 100644 --- a/include/etl/private/ivectorpointer.h +++ b/include/etl/private/ivectorpointer.h @@ -986,7 +986,7 @@ namespace etl /// Less than or equal operator. ///\param lhs Reference to the first vector. ///\param rhs Reference to the second vector. - ///\return true if the first vector is lexigraphically less than or equal to the second, otherwise false + ///\return true if the first vector is lexicographically less than or equal to the second, otherwise false ///\ingroup vector //*************************************************************************** template @@ -999,7 +999,7 @@ namespace etl /// Greater than or equal operator. ///\param lhs Reference to the first vector. ///\param rhs Reference to the second vector. - ///\return true if the first vector is lexigraphically greater than or equal to the second, otherwise false + ///\return true if the first vector is lexicographically greater than or equal to the second, otherwise false ///\ingroup vector //*************************************************************************** template diff --git a/include/etl/private/variant_variadic.h b/include/etl/private/variant_variadic.h index 28b2d99a0..651c9ff5e 100644 --- a/include/etl/private/variant_variadic.h +++ b/include/etl/private/variant_variadic.h @@ -997,7 +997,7 @@ namespace etl #if ETL_USING_CPP17 && !defined(ETL_VARIANT_FORCE_CPP11) //*************************************************************************** - /// Call the relevent visitor by attempting each one. + /// Call the relevant visitor by attempting each one. //*************************************************************************** template void do_visitor(TVisitor& visitor, etl::index_sequence) @@ -1006,7 +1006,7 @@ namespace etl } //*************************************************************************** - /// Call the relevent visitor by attempting each one. + /// Call the relevant visitor by attempting each one. //*************************************************************************** template void do_visitor(TVisitor& visitor, etl::index_sequence) const @@ -1015,7 +1015,7 @@ namespace etl } #else //*************************************************************************** - /// /// Call the relevent visitor. + /// /// Call the relevant visitor. //*************************************************************************** template void do_visitor(TVisitor& visitor) @@ -1065,7 +1065,7 @@ namespace etl } //*************************************************************************** - /// /// Call the relevent visitor. + /// /// Call the relevant visitor. //*************************************************************************** template void do_visitor(TVisitor& visitor) const @@ -1125,7 +1125,7 @@ namespace etl { // Workaround for MSVC (2023/05/13) // It doesn't compile 'visitor.visit(etl::get(*this))' correctly for C++17 & C++20. - // Changed all of the instances for consistancy. + // Changed all of the instances for consistency. auto& v = etl::get(*this); visitor.visit(v); return true; @@ -1146,7 +1146,7 @@ namespace etl { // Workaround for MSVC (2023/05/13) // It doesn't compile 'visitor.visit(etl::get(*this))' correctly for C++17 & C++20. - // Changed all of the instances for consistancy. + // Changed all of the instances for consistency. auto& v = etl::get(*this); visitor.visit(v); return true; @@ -1159,7 +1159,7 @@ namespace etl #if ETL_USING_CPP17 && !defined(ETL_VARIANT_FORCE_CPP11) //*************************************************************************** - /// Call the relevent visitor by attempting each one. + /// Call the relevant visitor by attempting each one. //*************************************************************************** template void do_operator(TVisitor& visitor, etl::index_sequence) @@ -1168,7 +1168,7 @@ namespace etl } //*************************************************************************** - /// Call the relevent visitor by attempting each one. + /// Call the relevant visitor by attempting each one. //*************************************************************************** template void do_operator(TVisitor& visitor, etl::index_sequence) const @@ -1177,7 +1177,7 @@ namespace etl } #else //*************************************************************************** - /// Call the relevent visitor. + /// Call the relevant visitor. //*************************************************************************** template void do_operator(TVisitor& visitor) @@ -1241,7 +1241,7 @@ namespace etl } //*************************************************************************** - /// Call the relevent visitor. + /// Call the relevant visitor. //*************************************************************************** template void do_operator(TVisitor& visitor) const @@ -1693,7 +1693,7 @@ namespace etl //*************************************************************************** /// Helper to instantiate the function pointers needed for the "jump table". - /// Embedds the 'TVarRest' (remaining variants) into its type to come around + /// Embeds the 'TVarRest' (remaining variants) into its type to come around /// the "double expansion" otherwise needed in "do_visit". //*************************************************************************** template diff --git a/include/etl/span.h b/include/etl/span.h index 797e35e5e..b37d8d2b8 100644 --- a/include/etl/span.h +++ b/include/etl/span.h @@ -720,7 +720,7 @@ namespace etl //************************************************************************* /// Equality function. - /// Performs a comparision of the range values. + /// Performs a comparison of the range values. /// Returns true if one of the following are true /// 1. Both spans are empty. /// 2. They both point to the same range of data. diff --git a/include/etl/to_arithmetic.h b/include/etl/to_arithmetic.h index f2e697435..81d5499b4 100644 --- a/include/etl/to_arithmetic.h +++ b/include/etl/to_arithmetic.h @@ -397,7 +397,7 @@ namespace etl TValue old_value = integral_value; integral_value *= radix; - // No multipication overflow? + // No multiplication overflow? is_not_overflow = ((integral_value / radix) == old_value); if (is_not_overflow) diff --git a/include/etl/type_traits.h b/include/etl/type_traits.h index cb4fc726a..816953d57 100644 --- a/include/etl/type_traits.h +++ b/include/etl/type_traits.h @@ -62,7 +62,7 @@ SOFTWARE. ///\defgroup type_traits type_traits /// A set of type traits definitions. -/// Derived from either the standard or alternate definitions, dependant on whether or not ETL_NO_STL is defined. +/// Derived from either the standard or alternate definitions, dependent on whether or not ETL_NO_STL is defined. /// \ingroup utilities #if ETL_USING_STL && ETL_USING_CPP11 diff --git a/include/etl/unordered_map.h b/include/etl/unordered_map.h index 0e5b9e35c..5cea106de 100644 --- a/include/etl/unordered_map.h +++ b/include/etl/unordered_map.h @@ -1508,7 +1508,7 @@ namespace etl } //********************************************************************* - /// Delete a data noe at the specified location. + /// Delete a data node at the specified location. //********************************************************************* local_iterator delete_data_node(local_iterator iprevious, local_iterator icurrent, bucket_t& bucket) { diff --git a/include/etl/unordered_multimap.h b/include/etl/unordered_multimap.h index 174b59783..61ef5b072 100644 --- a/include/etl/unordered_multimap.h +++ b/include/etl/unordered_multimap.h @@ -1362,7 +1362,7 @@ namespace etl } //********************************************************************* - /// Delete a data noe at the specified location. + /// Delete a data node at the specified location. //********************************************************************* local_iterator delete_data_node(local_iterator iprevious, local_iterator icurrent, bucket_t& bucket) { diff --git a/include/etl/unordered_multiset.h b/include/etl/unordered_multiset.h index be1acee7f..5af28a7e2 100644 --- a/include/etl/unordered_multiset.h +++ b/include/etl/unordered_multiset.h @@ -1340,7 +1340,7 @@ namespace etl } //********************************************************************* - /// Delete a data noe at the specified location. + /// Delete a data node at the specified location. //********************************************************************* local_iterator delete_data_node(local_iterator iprevious, local_iterator icurrent, bucket_t& bucket) { diff --git a/include/etl/unordered_set.h b/include/etl/unordered_set.h index 35dce097c..705622cff 100644 --- a/include/etl/unordered_set.h +++ b/include/etl/unordered_set.h @@ -1366,7 +1366,7 @@ namespace etl } //********************************************************************* - /// Delete a data noe at the specified location. + /// Delete a data node at the specified location. //********************************************************************* local_iterator delete_data_node(local_iterator iprevious, local_iterator icurrent, bucket_t& bucket) { diff --git a/support/Release notes.txt b/support/Release notes.txt index 69ad889d5..fce98a24f 100644 --- a/support/Release notes.txt +++ b/support/Release notes.txt @@ -156,7 +156,7 @@ Comments and noexcept updates to placement new etl::variant (variadic) refactor and updates for C++ standards compatibility etl::overload available in C++17 only map/flat_map speed optimisations -Various C++03 compatibilty updates for maps +Various C++03 compatibility updates for maps Refactored Bash compilation scripts to allow selection of C++ standard and optimisation level Renamed Bash compilation scripts. Changed 'sanity checks' to 'syntax checks Some internal constant case changes from all upper to capital case @@ -222,7 +222,7 @@ Removed unused ETL_USE_MEM_BUILTINS option =============================================================================== 20.35.7 -Updated etl::delgate to handle const functors correctly +Updated etl::delegate to handle const functors correctly =============================================================================== 20.35.6 @@ -270,7 +270,7 @@ Removed duplicate include in etl::array_view #621 No need to initialize the C-compiler, small speed improvement #626 Empty etl::optional ctor storage initialization performance Removed constexpr for etl::bit_cast due to unreliability of compiler support -Added has_value() as an alias for is_value() for etl::result (consistancy with STL conventions) +Added has_value() as an alias for is_value() for etl::result (consistency with STL conventions) Added ETL_ERROR_WITH_VALUE macro for exceptions that require a value Changed scaling template parameter for etl::scaled_rounding to uint32_t Remove redundant etl::pair functions @@ -467,7 +467,7 @@ Fixed send_message function signatures. 20.24.0 #503 Algorithm transform uses expensive post increment operator - Fixed for all occurrences of iterator increment. #504 ETL_CONSTANT vs const in binary.h - Fixed. -Many algorithms will leverage built-ins, if available. Dependant on compiler version. +Many algorithms will leverage built-ins, if available. Dependent on compiler version. Added detection or selection of built-ins. Much of etl::string and etl::string_view can be constexpr. Added ETL initializer_list implementations that are compatible with major compilers. @@ -835,7 +835,7 @@ Added example application for shared messages. Added a lockable queue with locks implemented as pure virtuals. Refactored the other queues. Fixed missing virtual destructor for C++11 observer. -Added etl::successor class for consistant 'chain of responsibilty' pattern generation. +Added etl::successor class for consistent 'chain of responsibilty' pattern generation. Added missing constructors to unique_ptr. Added nullptr check to unique_ptr destructor. Fixed VS2019 warning for etl::deque iterators. @@ -1803,7 +1803,7 @@ Added constexpr constructors to string_view and array_view. =============================================================================== 14.8.2 -Added missing #include "stl/interator.h" in frame_check_sequence.h +Added missing #include "stl/iterator.h" in frame_check_sequence.h =============================================================================== 14.8.1 @@ -2036,7 +2036,7 @@ Added SPSC & MPPC queues =============================================================================== 11.3.0 -Improved compatibility with 64 bit pltforms. +Improved compatibility with 64 bit platforms. =============================================================================== 11.2.0 @@ -2073,7 +2073,7 @@ Improved etl::endianness. Added static functions. =============================================================================== 10.19.2 -Fixed strict aliasing warnings for endianess. +Fixed strict aliasing warnings for endianness. =============================================================================== 10.19.1 @@ -2082,7 +2082,7 @@ Fixed strict aliasing warnings for aligned storage. =============================================================================== 10.19.0 Added 'create' and 'destroy' functions to pools. -Modified class heirarchy. +Modified class hierarchy. etl::generic_pool is derived from on etl::ipool. etl::pool is derived from etl::generic_pool. diff --git a/test/test_multimap.cpp b/test/test_multimap.cpp index afba0d694..90410fcaa 100644 --- a/test/test_multimap.cpp +++ b/test/test_multimap.cpp @@ -106,7 +106,7 @@ namespace //************************************************************************* struct SetupFixture { - // Multimaps of predefined data from which to constuct multimaps used in + // Multimaps of predefined data from which to construct multimaps used in // each test std::multimap initial_data; std::multimap excess_data; diff --git a/test/test_multiset.cpp b/test/test_multiset.cpp index 45d98fab3..4a9fab016 100644 --- a/test/test_multiset.cpp +++ b/test/test_multiset.cpp @@ -121,7 +121,7 @@ namespace //************************************************************************* struct SetupFixture { - // Multisets of predefined data from which to constuct multisets used in + // Multisets of predefined data from which to construct multisets used in // each test std::multiset initial_data; std::multiset excess_data;