-
Notifications
You must be signed in to change notification settings - Fork 1.2k
add explanation of rcl_logging_implementation. #6166
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.
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
base: rolling
Are you sure you want to change the base?
Conversation
Signed-off-by: Tomoya.Fujita <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR adds comprehensive documentation for the rcl_logging_implementation abstraction layer in ROS 2's logging subsystem. The documentation explains how ROS 2 supports both dynamic loading and static linking of logging backends, similar to the rmw_implementation pattern used for middleware selection.
Changes:
- Added documentation for the
RCL_LOGGING_IMPLEMENTATIONenvironment variable in the environment variables section - Updated the logging subsystem design description to clarify the two linking modes (dynamic and static)
- Added a new comprehensive section explaining
rcl_logging_implementation, including runtime dynamic loading vs static linking, environment variable configuration, implementation details, and use cases
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
HTML artifacts: https://github.com/ros2/ros2_documentation/actions/runs/21190243959/artifacts/5196996059. To view the resulting site:
|
Signed-off-by: Tomoya.Fujita <[email protected]>
peci1
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The proposed docs change looks good! However, I think it's also needed to change the diagram showing the library relations and add rcl_logging_implementation to it (and maybe also the two default logging libraries).
|
@peci1 ah yeah, right. i will replace that into the correct stack diagram. thanks 👍 |
Signed-off-by: Tomoya Fujita <[email protected]>
Signed-off-by: Tomoya Fujita <[email protected]>
|
@Yadunund @Barry-Xu-2018 workflow is green, can you review this? |
Barry-Xu-2018
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Signed-off-by: Tomoya Fujita <[email protected]>
Description
Part of ros2/rcl#1178
Did you use Generative AI?
Yes, Claude Sonnet 4.0
Additional Information