Document changes to rclcpp's logging macros#949
Merged
Conversation
Signed-off-by: Audrow Nash <audrow.nash@gmail.com>
clalancette
requested changes
Dec 15, 2020
Contributor
clalancette
left a comment
clalancette
left a comment
There was a problem hiding this comment.
I added some suggestions to give users more context on what they may need to change.
Contributor
|
(also, this PR should not be merged until we land ros2/rclcpp#1442) |
Signed-off-by: Audrow Nash <audrow.nash@gmail.com> Co-authored-by: Chris Lalancette <clalancette@openrobotics.org>
Signed-off-by: Audrow Nash <audrow.nash@gmail.com>
Signed-off-by: Audrow Nash <audrow.nash@gmail.com>
Signed-off-by: Audrow Nash <audrow.nash@gmail.com>
Member
Author
|
I've updated the |
clalancette
requested changes
Dec 17, 2020
Comment on lines
+148
to
+162
| If you are using a ``std::string`` as a format string with format arguments, converting that string to a ``char *`` and using it as the format string will yield a format security warning. To avoid the security warning, we recommend you build the string manually and pass it as in with no format arguments like the previous example. | ||
|
|
||
| If you don't care about the ``-Wformat-security`` warning and you previously had code like: | ||
|
|
||
| .. code-block:: | ||
|
|
||
| std::string my_std_string = "Foo %d"; | ||
| RCLCPP_DEBUG(get_logger(), my_std_string, 5); | ||
|
|
||
| you could replace it with: | ||
|
|
||
| .. code-block:: | ||
|
|
||
| std::string my_std_string = "Foo %d"; | ||
| RCLCPP_DEBUG(get_logger(), my_std_string.c_str(), 5); // raises -Wformat-security warning |
Contributor
There was a problem hiding this comment.
Honestly, I think this is somewhat redundant with the previous example. Also, I think we should explain why it ends up with the -Wformat-security warning. So I'd think about replacing this entire block with:
Note: if you are using a ``std::string`` as a format string with format arguments, converting that string to a ``char *`` and using it as the format string will yield a format security warning. That's because the compiler has no way at compile to introspect into the ``std::string`` to verify the arguments. To avoid the security warning, we recommend you build the string manually and pass it in with no format arguments like the previous example.
Member
Author
There was a problem hiding this comment.
Good call, I think this makes it much clearer.
Signed-off-by: Audrow Nash <audrow.nash@gmail.com>
clalancette
approved these changes
Dec 17, 2020
delete-merged-branch
bot
deleted the
audrow/galactic-rclcpp-logging-change
branch
clalancette
added a commit
that referenced
this pull request
Mar 11, 2021
clalancette
pushed a commit
that referenced
this pull request
Mar 11, 2021
* Add changes to rclcpp's logging macros Signed-off-by: Audrow Nash <audrow.nash@gmail.com> Co-authored-by: Chris Lalancette <clalancette@openrobotics.org> (cherry picked from commit 15eb141) Co-authored-by: Audrow Nash <audrow.nash@gmail.com>
clalancette
pushed a commit
that referenced
this pull request
Mar 11, 2021
* Add changes to rclcpp's logging macros Signed-off-by: Audrow Nash <audrow.nash@gmail.com> Co-authored-by: Chris Lalancette <clalancette@openrobotics.org> (cherry picked from commit 15eb141) Co-authored-by: Audrow Nash <audrow.nash@gmail.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
3 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.
This PR documents the changes from ros2/rclcpp#1442.