rename

Author: maksimdrachov

CMakeLists.txt

@@ -2,7 +2,7 @@
 # Copyright (c) 2024 Zubax Robotics  <[email protected]>
 
 cmake_minimum_required(VERSION 3.12)
-project(olg_scheduler_tests C CXX)
+project(olga_scheduler_tests C CXX)
 enable_testing()
 
 set(CTEST_OUTPUT_ON_FAILURE ON)
@@ -47,14 +47,14 @@ set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wsign-conversion -Wcast-align -Wmissing
 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wtype-limits -Wnon-virtual-dtor -Woverloaded-virtual")
 set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wno-attributes")
 
-add_executable(test_olg_scheduler_cpp20 ${CMAKE_CURRENT_SOURCE_DIR}/tests/test_olg_scheduler.cpp)
-set_target_properties(test_olg_scheduler_cpp20 PROPERTIES CXX_STANDARD 20)
-target_include_directories(test_olg_scheduler_cpp20 PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/include/olg_scheduler)
-target_include_directories(test_olg_scheduler_cpp20 SYSTEM PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/lib/cavl)
-target_link_libraries(test_olg_scheduler_cpp20
+add_executable(test_olga_scheduler_cpp20 ${CMAKE_CURRENT_SOURCE_DIR}/tests/test_olga_scheduler.cpp)
+set_target_properties(test_olga_scheduler_cpp20 PROPERTIES CXX_STANDARD 20)
+target_include_directories(test_olga_scheduler_cpp20 PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/include/olga_scheduler)
+target_include_directories(test_olga_scheduler_cpp20 SYSTEM PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/lib/cavl)
+target_link_libraries(test_olga_scheduler_cpp20
         PRIVATE
         GTest::gmock_main
 )
 
 include(GoogleTest)
-gtest_discover_tests(test_olg_scheduler_cpp20)
+gtest_discover_tests(test_olga_scheduler_cpp20)

README.md

@@ -1,11 +1,10 @@
-# olg_scheduler
+# olga_scheduler
 
-[![Main Workflow](https://github.com/zubax/olg_scheduler/actions/workflows/main.yml/badge.svg)](https://github.com/zubax/olg_scheduler/actions/workflows/main.yml)
+[![Main Workflow](https://github.com/zubax/olga_scheduler/actions/workflows/main.yml/badge.svg)](https://github.com/zubax/olga_scheduler/actions/workflows/main.yml)
 
 Generic single-file implementation of scheduler suitable for deeply embedded systems.
-"OLG" happens to be an abbreviation of [Okay Let's Go](https://www.youtube.com/watch?v=Jo6fKboqfMs)
-and also a reference to the fact that it has a logarithmic asymptotic complexity.
-**Simply copy `olg_scheduler.hpp` into your project tree and you are ready to roll.**
+"OLGa" is a reference to the fact that it has a logarithmic asymptotic complexity.
+**Simply copy `olga_scheduler.hpp` into your project tree and you are ready to roll.**
 The only dependency is the CAVL (`cavl.hpp`) header-only library
 (>= [v3.1.0](https://github.com/pavel-kirienko/cavl/tree/3.1.0)).
 
@@ -14,3 +13,8 @@ The code is fully covered by manual tests with full state space exploration.
 
 For development-related instructions please refer to the CI configuration files.
 To release a new version, simply create a new tag.
+
+<!--suppress CheckImageSize, HtmlDeprecatedAttribute -->
+<p align="center">
+    <img src="/docs/St_Olga_by_Nesterov_in_1892_(cropped).jpg" alt="Olga of Kiev" width=256>
+</p>

docs/St_Olga_by_Nesterov_in_1892_(cropped).jpg

@@ -1,4 +1,4 @@
-/// Source: https://github.com/zubax/olg_scheduler
+/// Source: https://github.com/zubax/olga_scheduler
 ///
 /// Copyright (c) 2024 Zubax Robotics  <[email protected]>
 ///
@@ -26,7 +26,7 @@
 #include <utility>
 #include <variant>
 
-namespace olg_scheduler
+namespace olga_scheduler
 {
 
 template <typename TimePoint>
@@ -362,4 +362,4 @@ class EventLoop final
 
 };  // EventLoop
 
-}  // namespace olg_scheduler
+}  // namespace olga_scheduler

include/olg_scheduler/olg_scheduler.hpp renamed to include/olga_scheduler/olga_scheduler.hpp

@@ -1,4 +1,4 @@
-/// Source: https://github.com/zubax/olg_scheduler
+/// Source: https://github.com/zubax/olga_scheduler
 ///
 /// Copyright (c) 2024 Zubax Robotics  <[email protected]>
 ///
@@ -15,7 +15,7 @@
 /// OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 /// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-#include "olg_scheduler.hpp"
+#include "olga_scheduler.hpp"
 
 #include <gmock/gmock.h>
 #include <gtest/gtest.h>
@@ -75,10 +75,10 @@ class SteadyClockMock final
 
 }  // namespace
 
-namespace olg_scheduler::verification
+namespace olga_scheduler::verification
 {
 
-TEST(TestOlgScheduler, EventLoopBasic)
+TEST(TestOlgaScheduler, EventLoopBasic)
 {
     using std::chrono_literals::operator""ms;
 
@@ -227,7 +227,7 @@ TEST(TestOlgScheduler, EventLoopBasic)
     EXPECT_FALSE(d);
 }
 
-TEST(TestOlgScheduler, EventLoopTotalOrdering)
+TEST(TestOlgaScheduler, EventLoopTotalOrdering)
 {
     using std::chrono_literals::operator""ms;
 
@@ -258,7 +258,7 @@ TEST(TestOlgScheduler, EventLoopTotalOrdering)
     EXPECT_THAT(c, 5);
 }
 
-TEST(TestOlgScheduler, EventLoopPoll)
+TEST(TestOlgaScheduler, EventLoopPoll)
 {
     using time_point = SteadyClockMock::time_point;
     using std::chrono_literals::operator""ms;
@@ -294,7 +294,7 @@ TEST(TestOlgScheduler, EventLoopPoll)
     EXPECT_THAT(evl.getTree()[0U]->getDeadline().value().time_since_epoch(), 210ms);  // Skipped ahead!
 }
 
-TEST(TestOlgScheduler, EventLoopDefer_single_overdue)
+TEST(TestOlgaScheduler, EventLoopDefer_single_overdue)
 {
     using time_point = SteadyClockMock::time_point;
     using std::chrono_literals::operator""ms;
@@ -316,7 +316,7 @@ TEST(TestOlgScheduler, EventLoopDefer_single_overdue)
     EXPECT_THAT(out.approx_now.time_since_epoch(), 1030ms);
 }
 
-TEST(TestOlgScheduler, EventLoopDefer_long_running_callback)
+TEST(TestOlgaScheduler, EventLoopDefer_long_running_callback)
 {
     using duration = SteadyClockMock::duration;
     using std::chrono_literals::operator""ms;
@@ -345,7 +345,7 @@ TEST(TestOlgScheduler, EventLoopDefer_long_running_callback)
                             std::make_tuple("b", 20ms, 100ms)));
 }
 
-TEST(TestOlgScheduler, HandleMovement)
+TEST(TestOlgaScheduler, HandleMovement)
 {
     using duration = SteadyClockMock::duration;
     using std::chrono_literals::operator""ms;
@@ -417,7 +417,7 @@ TEST(TestOlgScheduler, HandleMovement)
     EXPECT_THAT(calls, IsEmpty());
 }
 
-}  // namespace olg_scheduler::verification
+}  // namespace olga_scheduler::verification
 
 // NOLINTEND(cppcoreguidelines-avoid-magic-numbers, readability-magic-numbers)
 // NOLINTEND(readability-function-cognitive-complexity, misc-const-correctness)