chore: catchup to c473e96

c473e96 Add publishing configuration
d8d13ed Rename cmake project to COPEN
927784a Use separate build testing option
597d779 Add cmake user presets to ignore
8beefb2 Correct spelling in documentation
092ac92 Add build of c-open on jenkins

Based-On-Commit: c473e962176e1fbe2793224a7720cd1535d33116
Change-Id: I49fe317be3be4d9f3123b5a514b09d918ac6e0f0

Author: rt-labs bot

.github/README.md

@@ -0,0 +1,20 @@
+# Evaluation version
+
+This repository contains an evaluation version of **C-Open**, a CANopen
+stack for both master and slaves. It is especially well suited for
+embedded systems where resources are limited and efficiency is crucial.
+It is written in C and can be run on an RTOS such as rt-kernel, FreeRTOS,
+or on Linux.
+
+It does not contain any ports and cannot be built without adding additional sources.
+
+See:
+
+- [Readme](../README.md) for more information on the complete version of the stack.
+- [Releases](https://github.com/rtlabs-com/c-open/releases) for binary downloads for common targets.
+- [Product](https://rt-labs.com/product/c-open/) for license information as well as complete documentation.
+
+This version of C-Open can be used for evaluation purposes
+only. Contact <[email protected]> if you intend to use this stack in a
+product or if you need assistance during evaluation. The commercial
+version of this stack is supplied with full sources.

.github/workflows/build.yml

@@ -3,6 +3,7 @@ build*/
 *#
 CMakeFiles/
 CMakeCache.txt
+CMakeUserPresets.json
 install
 docs/_build
 

.github/workflows/codeql-analysis.yml

@@ -16,14 +16,15 @@
 cmake_minimum_required (VERSION 3.14)
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake/tools")
-project (CANOPEN VERSION 0.1.0)
+project (COPEN VERSION 1.0.0)
 
 # Default settings if this is the main project
-if (CMAKE_PROJECT_NAME STREQUAL CANOPEN)
+if (CMAKE_PROJECT_NAME STREQUAL COPEN)
   include(CTest)
 
   # Make option visible in ccmake, cmake-gui
   option (BUILD_SHARED_LIBS "Build shared library" OFF)
+  option (COPEN_BUILD_DOCS "Build documentation" ON)
 
   # Default to release build with debug info
   if (NOT CMAKE_BUILD_TYPE)
@@ -34,7 +35,7 @@ if (CMAKE_PROJECT_NAME STREQUAL CANOPEN)
 
   # Default to installing in build directory
   if (CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
-    set(CMAKE_INSTALL_PREFIX ${CANOPEN_BINARY_DIR}/install
+    set(CMAKE_INSTALL_PREFIX ${COPEN_BINARY_DIR}/install
       CACHE PATH "Default install path" FORCE)
   endif()
 
@@ -43,6 +44,7 @@ if (CMAKE_PROJECT_NAME STREQUAL CANOPEN)
   message(STATUS "Building for ${CMAKE_SYSTEM_NAME}")
 endif()
 
+include(CMakeDependentOption)
 include(AddOsal)
 include(GenerateExportHeader)
 include(CMakeDependentOption)
@@ -115,103 +117,110 @@ set(CO_THREAD_PRIO "10"
 set(CO_THREAD_STACK_SIZE "4096"
   CACHE STRING "stack size of main thread")
 
+cmake_dependent_option (COPEN_BUILD_TESTING
+  "Build testing on ${PROJECT_NAME}" ON
+  "BUILD_TESTING" OFF
+)
+
 # Generate version numbers
 configure_file (
   version.h.in
-  ${CANOPEN_BINARY_DIR}/src/version.h
+  ${COPEN_BINARY_DIR}/src/version.h
   )
 
 # Generate config options
 configure_file (
   co_options.h.in
-  ${CANOPEN_BINARY_DIR}/include/co_options.h
+  ${COPEN_BINARY_DIR}/include/co_options.h
   )
 configure_file (
   options.h.in
-  ${CANOPEN_BINARY_DIR}/src/options.h
+  ${COPEN_BINARY_DIR}/src/options.h
   )
 
 # Add platform-dependent targets early, so they can be configured by
 # platform
-add_library(canopen "")
+add_library(copen "")
 add_executable (slave "")
 add_executable (slaveinfo "")
 
-if (CMAKE_PROJECT_NAME STREQUAL CANOPEN AND BUILD_TESTING)
+if (COPEN_BUILD_TESTING)
   add_executable(co_test "")
 endif()
 
 # Platform configuration
 include(${CMAKE_CURRENT_SOURCE_DIR}/cmake/${CMAKE_SYSTEM_NAME}.cmake)
 
-generate_export_header(canopen
+generate_export_header(copen
   BASE_NAME co
-  EXPORT_FILE_NAME ${CANOPEN_BINARY_DIR}/include/co_export.h
+  EXPORT_FILE_NAME ${COPEN_BINARY_DIR}/include/co_export.h
   )
 
-set_target_properties (canopen slave slaveinfo
+set_target_properties (copen slave slaveinfo
   PROPERTIES
   C_STANDARD 99
   )
 
-target_compile_features(canopen PUBLIC c_std_99)
+target_compile_features(copen PUBLIC c_std_99)
 
-target_include_directories(canopen
+target_include_directories(copen
   PUBLIC
-  $<BUILD_INTERFACE:${CANOPEN_SOURCE_DIR}/include>
-  $<BUILD_INTERFACE:${CANOPEN_BINARY_DIR}/include>
+  $<BUILD_INTERFACE:${COPEN_SOURCE_DIR}/include>
+  $<BUILD_INTERFACE:${COPEN_BINARY_DIR}/include>
   $<INSTALL_INTERFACE:include>
   PRIVATE
-  ${CANOPEN_BINARY_DIR}/src
+  ${COPEN_BINARY_DIR}/src
   src
   )
 
-target_link_libraries(canopen PUBLIC osal)
+target_link_libraries(copen PUBLIC osal)
 
 install (
-  TARGETS canopen
-  EXPORT CanOpenConfig
+  TARGETS copen
+  EXPORT COpenConfig
   DESTINATION lib
   )
 
 install(
-  EXPORT CanOpenConfig
+  EXPORT COpenConfig
   DESTINATION cmake
   )
 
 install (FILES
   include/co_api.h
   include/co_obj.h
-  ${CANOPEN_BINARY_DIR}/include/co_export.h
-  ${CANOPEN_BINARY_DIR}/include/co_options.h
+  ${COPEN_BINARY_DIR}/include/co_export.h
+  ${COPEN_BINARY_DIR}/include/co_options.h
   DESTINATION include
   )
 
 add_subdirectory (src)
 add_subdirectory (util)
 
-if (CMAKE_PROJECT_NAME STREQUAL CANOPEN AND BUILD_TESTING)
+if (COPEN_BUILD_TESTING)
   add_subdirectory (test)
   include(AddGoogleTest)
   add_gtest(co_test)
 endif()
 
-if (CMAKE_PROJECT_NAME STREQUAL CANOPEN)
+if (COPEN_BUILD_DOCS)
   add_subdirectory(docs)
 
   add_custom_target(codespell
     COMMAND codespell
-        ${CANOPEN_SOURCE_DIR}/include/
-        ${CANOPEN_SOURCE_DIR}/docs/
-        ${CANOPEN_SOURCE_DIR}/src/
-        ${CANOPEN_SOURCE_DIR}/test/
+        ${COPEN_SOURCE_DIR}/include/
+        ${COPEN_SOURCE_DIR}/docs/
+        ${COPEN_SOURCE_DIR}/src/
+        ${COPEN_SOURCE_DIR}/test/
         --skip *_build*
     COMMENT "Running spell check on source code"
     )
 endif()
 
 
 include (InstallRequiredSystemLibraries)
-set (CPACK_RESOURCE_FILE_LICENSE "${CANOPEN_SOURCE_DIR}/LICENSE.md")
-set (CPACK_PACKAGE_CONTACT [email protected])
+set (CPACK_RESOURCE_FILE_LICENSE "${COPEN_SOURCE_DIR}/LICENSE.md")
+set (CPACK_PACKAGE_CONTACT [email protected])
+set (CPACK_PACKAGE_NAME c-open)
+set (CPACK_SYSTEM_NAME ${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_PROCESSOR})
 include (CPack)

.gitignore

@@ -0,0 +1,58 @@
+{
+    "version": 6,
+    "configurePresets": [
+        {
+            "name": "base",
+            "hidden": true,
+            "generator": "Ninja",
+            "binaryDir": "build/${presetName}"
+        },
+        {
+            "name": "linux",
+            "inherits" : "base",
+            "cacheVariables": {
+                "COPEN_BUILD_TESTING": true
+            }
+        },
+        {
+            "name": "docs",
+            "inherits" : "base",
+            "cacheVariables": {
+                "COPEN_BUILD_DOCS": true
+            }
+        }
+    ],
+    "buildPresets": [
+        {
+            "name": "linux",
+            "configurePreset": "linux"
+        },
+        {
+            "name": "docs",
+            "targets": ["sphinx-html", "sphinx-spelling", "codespell"],
+            "configurePreset": "docs"
+        }
+    ],
+    "packagePresets": [
+        {
+            "name": "linux",
+            "configurePreset": "linux",
+            "generators": [
+                "ZIP"
+            ]
+        }
+    ],
+    "testPresets": [
+        {
+            "name": "linux",
+            "configurePreset": "linux",
+            "output": {
+                "outputOnFailure": true
+            },
+            "execution": {
+                "noTestsAction": "error",
+                "stopOnFailure": true
+            }
+        }
+    ]
+}