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

Add documentation of log levels #93

Merged
merged 2 commits into from
May 15, 2020
Merged

Add documentation of log levels #93

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c35564b
Add documentation of log levels
tfoote Apr 2, 2020
fe46acf
rephrased based on review feedback
tfoote May 15, 2020
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
9 changes: 9 additions & 0 deletions rcl_interfaces/msg/Log.msg
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
##
## Severity level constants
##
## These logging levels follow the Python Standard
## https://docs.python.org/3/library/logging.html#logging-levels
## And are implemented in rcutils as well
## https://github.com/ros2/rcutils/blob/35f29850064e0c33a4063cbc947ebbfeada11dba/include/rcutils/logging.h#L164-L172
## This leaves space for other standard logging levels to be inserted in the middle in the future,
## as well as custom user defined levels.
## Since there are several other logging enumeration standard for different implementations,
## other logging implementations may need to provide level mappings to match their internal implementations.
Copy link
Member

Choose a reason for hiding this comment

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

Out of curiosity: why two #? Are these comments still being extracted properly and used in the generated code without any leading #?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I was just copying the existing style.

##
byte DEBUG=10 #debug level
byte INFO=20 #general level
Expand Down