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

Export the right library names #71

Merged
merged 5 commits into from
Mar 2, 2024
Merged

Export the right library names #71

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
928f472
Export the right library names
Ryanf55 Feb 26, 2024
85d21e1
Remove ament_export_libraries entirely
Ryanf55 Feb 27, 2024
ca32951
Remove not on not using filters_LIBRARIES
Ryanf55 Feb 29, 2024
362ee4c
Document details on an INTERFACE library usage for filter_base
Ryanf55 Mar 1, 2024
f0d96cb
Document different libraries exposed
Ryanf55 Mar 1, 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
3 changes: 1 addition & 2 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,9 +204,8 @@ endif()
# Install
##############################################################################

# Export old-style CMake variables
# Export old-style CMake variables for includes
ament_export_include_directories("include/${PROJECT_NAME}")
ament_export_libraries(${PROJECT_NAME})

# Export modern CMake targets
ament_export_targets(export_${PROJECT_NAME} HAS_LIBRARY_TARGET)
Expand Down
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Filters

## Usage with ament_cmake

Here is recommended approach on how to link `filters` to your project, using the `filter_base` target.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One small request: could you add one more sentence explaining to users what depending on filters_base does? Something along the lines of "linking to filters_base pulls in all necessary libraries and include directories for targets with classes that extend FilterBase".

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And also a comment for the add_library(filter_base ...) in the CMakelists.txt for old ROS folks like me who are coming across interface libraries for the first time. Something like "filter_base is a cmake "interface library" which doesn't compile anything, but can be depended on by other targets so that all needed libraries and include directories are pulled in"

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done and done. I reworked it it a bit. Most people probably want to link to one of the pre-written filters.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the way you worded the comments.


```cmake
find_package(filters CONFIG REQUIRED)

add_library(my_library)
# Other library stuff here

target_link_libraries(my_library PUBLIC filters::filter_base)
```

For more information,
see the [ament_cmake](https://docs.ros.org/en/rolling/How-To-Guides/Ament-CMake-Documentation.html)
tutorial.