doc: Added warning to not instantiate Clock directly with RCL_ROS_TIME#2768
Merged
christophebedard merged 2 commits intoros2:rollingfrom Mar 14, 2025
Merged
Conversation
If one instantiates a clock with RCL_ROS_TIME one needs to make sure, to attach a valid time source, or the clock will fall back to system time, which is highly unexpected for users of the clock. Signed-off-by: Janosch Machowinski <J.Machowinski@cellumation.com>
Collaborator
Author
|
@tfoote @fujitatomoya @alsora A short review please ;-) |
fujitatomoya
approved these changes
Mar 14, 2025
Collaborator
fujitatomoya
left a comment
There was a problem hiding this comment.
i am okay to have this warning in doc section.
Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com> Signed-off-by: Janosch Machowinski <jmachowinski@users.noreply.github.com>
Collaborator
|
Pulls: #2768
|
Collaborator
|
Note backport to jazzy and humble required. |
alsora
approved these changes
Mar 14, 2025
tfoote
approved these changes
Mar 14, 2025
Contributor
tfoote
left a comment
There was a problem hiding this comment.
Thanks for adding this warning that will hopefully help others not get caught.
Member
|
@Mergifyio backport jazzy humble |
Contributor
✅ Backports have been createdDetails
|
mergify bot
pushed a commit
that referenced
this pull request
Mar 14, 2025
#2768) Signed-off-by: Janosch Machowinski <J.Machowinski@cellumation.com> Signed-off-by: Janosch Machowinski <jmachowinski@users.noreply.github.com> Co-authored-by: Janosch Machowinski <J.Machowinski@cellumation.com> Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com> (cherry picked from commit 30e61c9)
mergify bot
pushed a commit
that referenced
this pull request
Mar 14, 2025
#2768) Signed-off-by: Janosch Machowinski <J.Machowinski@cellumation.com> Signed-off-by: Janosch Machowinski <jmachowinski@users.noreply.github.com> Co-authored-by: Janosch Machowinski <J.Machowinski@cellumation.com> Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com> (cherry picked from commit 30e61c9)
This was referenced Mar 14, 2025
Merged
christophebedard
pushed a commit
that referenced
this pull request
Mar 15, 2025
#2768) (#2769) Signed-off-by: Janosch Machowinski <J.Machowinski@cellumation.com> Signed-off-by: Janosch Machowinski <jmachowinski@users.noreply.github.com> Co-authored-by: Janosch Machowinski <J.Machowinski@cellumation.com> Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com> (cherry picked from commit 30e61c9) Co-authored-by: Janosch Machowinski <jmachowinski@users.noreply.github.com>
christophebedard
pushed a commit
that referenced
this pull request
Mar 15, 2025
#2768) (#2770) Signed-off-by: Janosch Machowinski <J.Machowinski@cellumation.com> Signed-off-by: Janosch Machowinski <jmachowinski@users.noreply.github.com> Co-authored-by: Janosch Machowinski <J.Machowinski@cellumation.com> Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com> (cherry picked from commit 30e61c9) Co-authored-by: Janosch Machowinski <jmachowinski@users.noreply.github.com>
jplapp
pushed a commit
to pixel-robotics/rclcpp
that referenced
this pull request
Apr 9, 2025
ros2#2768) (ros2#2769) Signed-off-by: Janosch Machowinski <J.Machowinski@cellumation.com> Signed-off-by: Janosch Machowinski <jmachowinski@users.noreply.github.com> Co-authored-by: Janosch Machowinski <J.Machowinski@cellumation.com> Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com> (cherry picked from commit 30e61c9) Co-authored-by: Janosch Machowinski <jmachowinski@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
If one instantiates a clock with RCL_ROS_TIME one needs to make sure, to attach a valid time source, or the clock will fall back to system time, which is highly unexpected for users of the clock.