From 46e947c69bd5df2df06e341be5620ec9f6c70213 Mon Sep 17 00:00:00 2001 From: Christoph Froehlich Date: Tue, 10 Mar 2026 20:44:44 +0000 Subject: [PATCH 1/2] Remove deprecated include path --- README.md | 37 ++++++++++++------- .../cmake/generate_parameter_library.cmake | 15 -------- 2 files changed, 24 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index c262063..6d1b04a 100644 --- a/README.md +++ b/README.md @@ -91,7 +91,7 @@ generate_parameter_module( **src/turtlesim.cpp** ```c++ #include -#include // you can also use the deprecated #include "turtlesim_parameters.hpp" +#include int main(int argc, char * argv[]) { @@ -155,18 +155,29 @@ when using `gmock` test library. 🤖 P.S. having this example yaml files will make your users very grateful because they will always have a working example of a configuration for your node. ## Detailed Documentation -* [Cpp namespace](#cpp-namespace) -* [Parameter definition](#parameter-definition) -* [Built-In Validators](#built-in-validators) -* [Custom validator functions](#custom-validator-functions) -* [Nested structures](#nested-structures) -* [Mapped parameters](#mapped-parameters) -* [Use generated struct in Cpp](#use-generated-struct-in-cpp) -* [Dynamic Parameters](#dynamic-parameters) -* [Parameter documentation](#parameter-documentation) -* [Example Project](#example-project) -* [Generated code output](#generated-code-output) -* [Generate markdown documentation](#generate-markdown-documentation) +- [generate\_parameter\_library](#generate_parameter_library) + - [TOC](#toc) + - [Killer Features](#killer-features) + - [Basic Usage](#basic-usage) + - [Create yaml parameter codegen file](#create-yaml-parameter-codegen-file) + - [Add parameter library generation to project](#add-parameter-library-generation-to-project) + - [Use generated struct in project source code](#use-generated-struct-in-project-source-code) + - [Use example yaml files in tests](#use-example-yaml-files-in-tests) + - [Detailed Documentation](#detailed-documentation) + - [Cpp namespace](#cpp-namespace) + - [Parameter definition](#parameter-definition) + - [Built-In Validators](#built-in-validators) + - [Custom validator functions](#custom-validator-functions) + - [Nested structures](#nested-structures) + - [Mapped parameters](#mapped-parameters) + - [Use generated struct in Cpp](#use-generated-struct-in-cpp) + - [Dynamic Parameters](#dynamic-parameters) + - [Parameter documentation](#parameter-documentation) + - [Example Project](#example-project) + - [Generated code output](#generated-code-output) + - [Generate markdown documentation](#generate-markdown-documentation) +- [FAQ](#faq) + - [Build status](#build-status) ### Cpp namespace The root element of the YAML file determines the namespace used in the generated C++ code. diff --git a/generate_parameter_library/cmake/generate_parameter_library.cmake b/generate_parameter_library/cmake/generate_parameter_library.cmake index 8094ade..bec339b 100644 --- a/generate_parameter_library/cmake/generate_parameter_library.cmake +++ b/generate_parameter_library/cmake/generate_parameter_library.cmake @@ -49,8 +49,6 @@ macro(generate_parameter_library LIB_NAME YAML_FILE) # Copy the header file into the include directory file(COPY ${IN_VALIDATE_HEADER} DESTINATION ${LIB_INCLUDE_DIR}) - # necessary so that #include can be used in the local package (deprecated) - file(COPY ${IN_VALIDATE_HEADER} DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/include) endif() # Set the yaml file parameter to be relative to the current source dir @@ -68,19 +66,6 @@ macro(generate_parameter_library LIB_NAME YAML_FILE) "Running `${generate_parameter_library_cpp_BIN} ${PARAM_HEADER_FILE} ${YAML_FILE_PATH} ${VALIDATE_HEADER_FILENAME}`" VERBATIM ) - # necessary so that #include can be used in the local package (deprecated) - set(LOCAL_PARAM_HEADER_FILE ${CMAKE_CURRENT_BINARY_DIR}/include/${LIB_NAME}.hpp) - set(LOCAL_PARAM_HEADER_PRAGMA_WARNING_FILE ${CMAKE_CURRENT_BINARY_DIR}/${LIB_NAME}_pragma_warning) - file(WRITE ${LOCAL_PARAM_HEADER_PRAGMA_WARNING_FILE} - "#pragma message(\"#include \\\"${LIB_NAME}.hpp\\\" is deprecated. Use #include <${PROJECT_NAME}/${LIB_NAME}.hpp> instead.\")\n") - add_custom_command( - OUTPUT ${LOCAL_PARAM_HEADER_FILE} - COMMAND ${CMAKE_COMMAND} -E cat ${LOCAL_PARAM_HEADER_PRAGMA_WARNING_FILE} ${PARAM_HEADER_FILE} > ${LOCAL_PARAM_HEADER_FILE} - DEPENDS ${PARAM_HEADER_FILE} - COMMENT - "Creating deprecated header file ${LOCAL_PARAM_HEADER_FILE}" - VERBATIM - ) # Create the library target add_library(${LIB_NAME} INTERFACE ${PARAM_HEADER_FILE} ${VALIDATE_HEADER} ${LOCAL_PARAM_HEADER_FILE}) From 5f4dd2bdb4835d7581a64748f56625b99c1a2f0d Mon Sep 17 00:00:00 2001 From: Christoph Froehlich Date: Tue, 10 Mar 2026 20:45:35 +0000 Subject: [PATCH 2/2] Revert format change --- README.md | 35 ++++++++++++----------------------- 1 file changed, 12 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 6d1b04a..b21e764 100644 --- a/README.md +++ b/README.md @@ -155,29 +155,18 @@ when using `gmock` test library. 🤖 P.S. having this example yaml files will make your users very grateful because they will always have a working example of a configuration for your node. ## Detailed Documentation -- [generate\_parameter\_library](#generate_parameter_library) - - [TOC](#toc) - - [Killer Features](#killer-features) - - [Basic Usage](#basic-usage) - - [Create yaml parameter codegen file](#create-yaml-parameter-codegen-file) - - [Add parameter library generation to project](#add-parameter-library-generation-to-project) - - [Use generated struct in project source code](#use-generated-struct-in-project-source-code) - - [Use example yaml files in tests](#use-example-yaml-files-in-tests) - - [Detailed Documentation](#detailed-documentation) - - [Cpp namespace](#cpp-namespace) - - [Parameter definition](#parameter-definition) - - [Built-In Validators](#built-in-validators) - - [Custom validator functions](#custom-validator-functions) - - [Nested structures](#nested-structures) - - [Mapped parameters](#mapped-parameters) - - [Use generated struct in Cpp](#use-generated-struct-in-cpp) - - [Dynamic Parameters](#dynamic-parameters) - - [Parameter documentation](#parameter-documentation) - - [Example Project](#example-project) - - [Generated code output](#generated-code-output) - - [Generate markdown documentation](#generate-markdown-documentation) -- [FAQ](#faq) - - [Build status](#build-status) +* [Cpp namespace](#cpp-namespace) +* [Parameter definition](#parameter-definition) +* [Built-In Validators](#built-in-validators) +* [Custom validator functions](#custom-validator-functions) +* [Nested structures](#nested-structures) +* [Mapped parameters](#mapped-parameters) +* [Use generated struct in Cpp](#use-generated-struct-in-cpp) +* [Dynamic Parameters](#dynamic-parameters) +* [Parameter documentation](#parameter-documentation) +* [Example Project](#example-project) +* [Generated code output](#generated-code-output) +* [Generate markdown documentation](#generate-markdown-documentation) ### Cpp namespace The root element of the YAML file determines the namespace used in the generated C++ code.