Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update proto2ros CMake macros documentation #125

Merged
merged 2 commits into from
Oct 8, 2024
Merged

Update proto2ros CMake macros documentation #125

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
95db56c
Update proto2ros CMake macros documentation
mhidalgo-bdai Oct 7, 2024
6afac3a
Address peer review comments
mhidalgo-bdai Oct 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions proto2ros/cmake/proto2ros_generate.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@
# Defaults to the target name with an `_interfaces` suffix.
# :param PYTHON_OUT_VAR: the name of the variable to yield generated Python sources.
# Defaults to the target name with a `_python_sources` suffix.
# :param CPP_OUT_VAR: the name of the variable to yield generated C++ sources
# (both .cpp and .hpp files). Defaults to the target name with a `_cpp_sources` suffix.
# :param INCLUDE_OUT_VAR: the name of the variable to yield the path to generated
# C++ includes. Defaults to the target name with a `_cpp_include` suffix.
# :param DEPENDS: optional, additional dependencies to the generation command.
# This can be useful to depend on earlier protobuf_generate() commands.
# :param APPEND_PYTHONPATH: optional paths to append to the PYTHONPATH that applies
# to the generation process.
# :param NO_LINT: if provided, no lint tests are added for generated code.
Expand Down
19 changes: 18 additions & 1 deletion proto2ros/cmake/proto2ros_vendor_package.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,24 @@
# are provided. If none is given, parent directories of PROTOS are used instead.
# :param CONFIG_OVERLAYS: optional configuration file overlays to be applied sequentially
# over the default base configuration file.
#
# :param ROS_DEPENDENCIES: optional ROS package name to depend on for message generation and builds.
# :param CPP_DEPENDENCIES: optional C++ targets to depend on for library builds.
# :param CPP_INCLUDES: optional, additional C++ includes to use when building C++ sources.
# If none is provided and ${CMAKE_CURRENT_SOURCE_DIR}/include/${ARG_PACKAGE_NAME} exists
# as a directory, then it will be picked up by default.
# :param CPP_SOURCES: optional, additional C++ sources to build alongside generated C++ sources.
# If none is provided and both ${CMAKE_CURRENT_SOURCE_DIR}/include/${ARG_PACKAGE_NAME} and
# ${CMAKE_CURRENT_SOURCE_DIR}/src exist as directories, then source files matching either
# ${CMAKE_CURRENT_SOURCE_DIR}/src/*.cc or ${CMAKE_CURRENT_SOURCE_DIR}/src/*.cpp glob
# expressions will be picked up by default.
# :param PYTHON_MODULES: optional, additional Python module sources to install
# alongside generated Python modules.
# :param PYTHON_PACKAGES: optional, additional Python packages to install alongside
# generated Python packages. If none is provided and one is found under the
# ${CMAKE_CURRENT_SOURCE_DIR}/${PACKAGE_NAME}, it will be picked up by default.
# :param DEPENDS: optional, additional dependencies to the generation command.
# This can be useful to depend on earlier protobuf_generate() commands.
# :param NO_LINT: if provided, no lint tests are added for generated code.
macro(proto2ros_vendor_package target)
set(options NO_LINT)
set(one_value_keywords PACKAGE_NAME)
Expand Down
Loading