Skip to content

Commit

Permalink
README update and some cleanups. (#120)
Browse files Browse the repository at this point in the history
Signed-off-by: Tomoya Fujita <Tomoya.Fujita@sony.com>
  • Loading branch information
fujitatomoya authored Sep 5, 2024
1 parent 7529e87 commit 4d186fa
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 10 deletions.
6 changes: 1 addition & 5 deletions rcl_logging_noop/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,7 @@ if(NOT WIN32)
add_compile_options(-Wall -Wextra -Wpedantic)
endif()

set(${PROJECT_NAME}_sources
src/rcl_logging_noop/rcl_logging_noop.cpp
)

add_library(${PROJECT_NAME} ${${PROJECT_NAME}_sources})
add_library(${PROJECT_NAME} src/rcl_logging_noop.cpp)

target_link_libraries(${PROJECT_NAME} PRIVATE
rcutils::rcutils)
Expand Down
18 changes: 18 additions & 0 deletions rcl_logging_noop/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# rcl_logging_noop

Package supporting an implementation of no-op logging functionality.

[rcl_logging_noop](src/rcl_logging_noop.cpp) logging interface implementation can:
- initialize
- log a message
- set the logger level
- shutdown

## Build

Currently there is no way to select the logging interface implementation without building [rcl](https://github.com/ros2/rcl) with target logging interface implementation.

```bash
export RCL_LOGGING_IMPLEMENTATION=rcl_logging_noop
colcon build --symlink-install --cmake-clean-cache --packages-select rcl_logging_noop rcl
```
File renamed without changes.
6 changes: 1 addition & 5 deletions rcl_logging_spdlog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,12 @@

Package supporting an implementation of logging functionality using `spdlog`.

[rcl_logging_spdlog](include/rcl_logging_spdlog/logging_interface.h) logging interface implementation can:
[rcl_logging_spdlog](src/rcl_logging_spdlog.cpp) logging interface implementation can:
- initialize
- log a message
- set the logger level
- shutdown

Some useful internal abstractions and utilities:
- Macros for controlling symbol visibility on the library
- [rcl_logging_spdlog/visibility_control.h](include/rcl_logging_spdlog/visibility_control.h)

## Quality Declaration

This package claims to be in the **Quality Level 1** category, see the [Quality Declaration](./QUALITY_DECLARATION.md) for more details.

0 comments on commit 4d186fa

Please sign in to comment.