Merge pull request #1 from aeriqkim/main

Update reference to libethard to libudpard

Author: SchoberMJ

README.md

@@ -1,14 +1,18 @@
+# NOTICE
+
+This package is a staging package to make changes before committing a pull request for the github repo: https://github.com/OpenCyphal-Garage/libudpard based on @schoberm's prototype work
+
 # Compact Cyphal/UDP v0 in C
 
-Libethard is a compact implementation of the Cyphal/UDP protocol stack in C99/C11 for high-integrity real-time
+Libudpard is a compact implementation of the Cyphal/UDP protocol stack in C99/C11 for high-integrity real-time
 embedded systems.
 
 [Cyphal](https://opencyphal.org) is an open lightweight data bus standard designed for reliable intravehicular
-communication in aerospace and robotic applications via CAN bus, Ethernet, and other robust transports.
+communication in aerospace and robotic applications via CAN bus, UDP, and other robust transports.
 
 ## WORK IN PROGRESS, NOT READY FOR FORMAL USE
 
-**Read the docs in [`libethard/ethard.h`](/libethard/ethard.h).**
+**Read the docs in [`libudpard/udpard.h`](/libudpard/udpard.h).**
 
 Building
 ```
@@ -17,6 +21,7 @@ cmake -B ./build -DCMAKE_BUILD_TYPE=Debug -DNO_STATIC_ANALYSIS=1 -DCMAKE_C_COMPI
 Testing
 ```
 cd build
+make
 make test
 ```
 

libethard/.clang-format libudpard/.clang-formatlibethard/.clang-format renamed to libudpard/.clang-format

@@ -23,11 +23,11 @@
 
 #pragma once
 
-#include "ethard.h"
+#include "udpard.h"
 
-/// Modified for use with Libethard: use the same assertion check macro if provided.
-#ifdef ETHARD_ASSERT
-#    define CAVL_ASSERT ETHARD_ASSERT
+/// Modified for use with Libudpard: use the same assertion check macro if provided.
+#ifdef UDPARD_ASSERT
+#    define CAVL_ASSERT UDPARD_ASSERT
 #else
 // Intentional violation of MISRA: inclusion not at the top of the file to eliminate unnecessary dependency on assert.h.
 #    include <assert.h>  // NOSONAR
@@ -42,8 +42,8 @@ extern "C" {
 
 // ----------------------------------------         PUBLIC API SECTION         ----------------------------------------
 
-/// Modified for use with Libethard: expose the Cavl structure via public API as EthardTreeNode.
-typedef EthardTreeNode Cavl;
+/// Modified for use with Libudpard: expose the Cavl structure via public API as UdpardTreeNode.
+typedef UdpardTreeNode Cavl;
 
 /// Returns POSITIVE if the search target is GREATER than the provided node, negative if smaller, zero on match (found).
 /// Values other than {-1, 0, +1} are not recommended to avoid overflow during the narrowing conversion of the result.

libethard/.clang-tidy libudpard/.clang-tidylibethard/.clang-tidy renamed to libudpard/.clang-tidy

@@ -1,14 +1,14 @@
 # This software is distributed under the terms of the MIT License.
 # Copyright (c) 2016 OpenCyphal.
 # Author: Pavel Kirienko <[email protected]>
-# Contributors: https://github.com/OpenCyphal/libethard/contributors.
+# Contributors: https://github.com/OpenCyphal/libudpard/contributors.
 
 cmake_minimum_required(VERSION 3.12)
-project(ethard_tests C CXX)
+project(udpard_tests C CXX)
 enable_testing()
 
 set(CTEST_OUTPUT_ON_FAILURE ON)
-set(library_dir "${CMAKE_SOURCE_DIR}/../libethard")
+set(library_dir "${CMAKE_SOURCE_DIR}/../libudpard")
 
 # Use -DNO_STATIC_ANALYSIS=1 to suppress static analysis.
 # If not suppressed, the tools used here shall be available, otherwise the build will fail.
@@ -45,7 +45,7 @@ set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Woverloaded-virtual -Wnon-virtual-dtor
 include_directories(catch ${library_dir})
 add_definitions(-DCATCH_CONFIG_FAST_COMPILE=1 -DCATCH_CONFIG_ENABLE_ALL_STRINGMAKERS=1)
 
-set(common_sources catch/main.cpp ${library_dir}/ethard.c)
+set(common_sources catch/main.cpp ${library_dir}/udpard.c)
 
 function(gen_test name files compile_definitions compile_flags link_flags c_standard)
     add_executable(${name} ${common_sources} ${files})
@@ -80,7 +80,7 @@ endfunction()
 # Disable missing declaration warning to allow exposure of private definitions.
 gen_test_matrix(test_private
         "test_private_crc.cpp;test_private_rx.cpp;test_private_tx.cpp;test_private_cavl.cpp;"
-        "-DETHARD_CONFIG_HEADER=\"${CMAKE_CURRENT_SOURCE_DIR}/ethard_config_private.h\""
+        "-DUDPARD_CONFIG_HEADER=\"${CMAKE_CURRENT_SOURCE_DIR}/udpard_config_private.h\""
         "-Wno-missing-declarations")
 
 gen_test_matrix(test_public