Add documentation for log format placeholders.#6045
Add documentation for log format placeholders.#6045alexmaclean6 wants to merge 6 commits intoros2:rollingfrom
Conversation
Signed-off-by: Alex MacLean <macleale@amazon.com>
|
wait for this PR ros2/rcutils#526 (comment) |
Signed-off-by: Alex MacLean <macleale@amazon.com>
kscottz
left a comment
kscottz
left a comment
There was a problem hiding this comment.
This is a fantastic addition. Thank you so much!
| ^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| If you would like more or less verbose formatting, you can use the ``RCUTILS_CONSOLE_OUTPUT_FORMAT`` environment variable. | ||
| It provides the following options for formatting the log line: |
There was a problem hiding this comment.
This info seems to already be here: https://github.com/ros2/ros2_documentation/blob/rolling/source/Concepts/Intermediate/About-Logging.rst#id5
maybe link to it?
There was a problem hiding this comment.
ah it's actually already linked at line 423
There was a problem hiding this comment.
So we're good to go here?
There was a problem hiding this comment.
No I think this section doesn't need to be added because it's already linked at line 423
There was a problem hiding this comment.
@tonynajjar thanks for pointing that out, and that is right. i believe what we should do here is to add the additional tokens to https://docs.ros.org/en/rolling/Concepts/Intermediate/About-Logging.html#environment-variables. this PR generates the duplication.
There was a problem hiding this comment.
agreed, see https://github.com/ros2/ros2_documentation/pull/6226/changes for reference
| ^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| If you would like more or less verbose formatting, you can use the ``RCUTILS_CONSOLE_OUTPUT_FORMAT`` environment variable. | ||
| It provides the following options for formatting the log line: |
There was a problem hiding this comment.
@tonynajjar thanks for pointing that out, and that is right. i believe what we should do here is to add the additional tokens to https://docs.ros.org/en/rolling/Concepts/Intermediate/About-Logging.html#environment-variables. this PR generates the duplication.
|
@alexmaclean6 are you still working on this? |
5 participants
Description
This pull request adds documentation for the log format tokens (
{severity},{function_name}, etc.). It includes{severity_with_color}, a new token introduced in a separate pull request.Did you use Generative AI?
No