diff --git a/rclcpp/QUALITY_DECLARATION.md b/rclcpp/QUALITY_DECLARATION.md index 6fe97bd..1767712 100644 --- a/rclcpp/QUALITY_DECLARATION.md +++ b/rclcpp/QUALITY_DECLARATION.md @@ -1,4 +1,4 @@ -This document is a declaration of software quality for the `rclcpp` package, based on the guidelines in [REP-2004](https://github.com/ros-infrastructure/rep/blob/rep-2004/rep-2004.rst). +This document is a declaration of software quality for the `rclcpp` package, based on the guidelines in [REP-2004](https://www.ros.org/reps/rep-2004.html). # `rclcpp` Quality Declaration @@ -137,20 +137,63 @@ Currently nightly test results can be seen here: ## Dependencies [5] +Below are evaluations of each of `rclcpp`'s run-time and build-time dependencies that have been determined to influence the quality. + +It has several "buildtool" dependencies, which do not affect the resulting quality of the package, because they do not contribute to the public library API. + +It also has several test dependencies, which do not affect the resulting quality of the package, because they are only used to build and run the test code. + ### Direct and Optional Runtime ROS Dependencies [5.i]/[5.ii] `rclcpp` has the following runtime ROS dependencies: - - libstatistics_collector - - rcl - - rcl_yaml_param_parser - - rcpputils - - rcutils - - rmw - - statistics_msgs - - tracetools -It has several "buildtool" dependencies, which do not affect the resulting quality of the package, because they do not contribute to the public library API. -It also has several test dependencies, which do not affect the resulting quality of the package, because they are only used to build and run the test code. +#### `libstatistics_collector` + +The `libstatistics_collector` package provides lightweight aggregation utilities to collect statistics and measure message metrics. + +It is **Quality Level 4**, see its [Quality Declaration document](https://github.com/ros-tooling/libstatistics_collector/tree/master/QUALITY_DECLARATION.md). + +#### `rcl` + +`rcl` a library to support implementation of language specific ROS 2 Client Libraries. + +It is **Quality Level 4**, see its [Quality Declaration document](https://github.com/ros2/rcl/blob/master/rcl/QUALITY_DECLARATION.md). + +#### `rcl_yaml_param_parser` + +The `rcl_yaml_param_parser` package provides an API that is used to parse YAML configuration files which may be used to configure ROS and specific nodes. + +It is **Quality Level 4**, see its [Quality Declaration document](https://github.com/ros2/rcl/tree/master/rcl_yaml_param_parser/QUALITY_DECLARATION.md). + +#### `rcpputils` + +The `rcpputils` package provides an API which contains common utilities and data structures useful when programming in C++. + +It is **Quality Level 4**, see its [Quality Declaration document](https://github.com/ros2/rcpputils/blob/master/QUALITY_DECLARATION.md). + +#### `rcutils` + +The `rcutils` package provides an API which contains common utilities and data structures useful when programming in C. + +It is **Quality Level 4**, see its [Quality Declaration document](https://github.com/ros2/rcutils/blob/master/QUALITY_DECLARATION.md). + +#### `rmw` + +`rmw` is the ROS 2 middleware library. + +It is **Quality Level 4**, see its [Quality Declaration document](https://github.com/ros2/rmw/blob/master/rmw/QUALITY_DECLARATION.md). + +#### `statistics_msgs` + +The `statistics_msgs` package contains ROS 2 message definitions for reporting statistics for topics and system resources. + +It is **Quality Level 4**, see its [Quality Declaration document](https://github.com/ros2/rcl_interfaces/blob/master/statistics_msgs/QUALITY_DECLARATION.md). + +#### `tracetools` + +The `tracetools` package provides utilities for instrumenting the code in `rcl` so that it may be traced for debugging and performance analysis. + +It is **Quality Level 4**, see its [Quality Declaration document](https://gitlab.com/micro-ROS/ros_tracing/ros2_tracing/-/blob/master/tracetools/QUALITY_DECLARATION.md). ### Direct Runtime non-ROS Dependency [5.iii] diff --git a/rclcpp_action/QUALITY_DECLARATION.md b/rclcpp_action/QUALITY_DECLARATION.md index ba27649..fc15b0a 100644 --- a/rclcpp_action/QUALITY_DECLARATION.md +++ b/rclcpp_action/QUALITY_DECLARATION.md @@ -1,4 +1,4 @@ -This document is a declaration of software quality for the `rclcpp_action` package, based on the guidelines in [REP-2004](https://github.com/ros-infrastructure/rep/blob/rep-2004/rep-2004.rst). +This document is a declaration of software quality for the `rclcpp_action` package, based on the guidelines in [REP-2004](https://www.ros.org/reps/rep-2004.html). # `rclcpp_action` Quality Declaration @@ -135,15 +135,33 @@ Currently nightly test results can be seen here: ## Dependencies [5] +Below are evaluations of each of `rclcpp_action`'s run-time and build-time dependencies that have been determined to influence the quality. + +It has several "buildtool" dependencies, which do not affect the resulting quality of the package, because they do not contribute to the public library API. + +It also has several test dependencies, which do not affect the resulting quality of the package, because they are only used to build and run the test code. + ### Direct and Optional Runtime ROS Dependencies [5.i]/[5.ii] `rclcpp_action` has the following runtime ROS dependencies: - - action_msgs - - rclcpp - - rcl_action -It has several "buildtool" dependencies, which do not affect the resulting quality of the package, because they do not contribute to the public library API. -It also has several test dependencies, which do not affect the resulting quality of the package, because they are only used to build and run the test code. +#### `action_msgs` + +`action_msgs` provides messages and services for ROS 2 actions. + +It is **Quality Level 4**, see its [Quality Declaration document](https://github.com/ros2/rcl_interfaces/blob/master/action_msgs/QUALITY_DECLARATION.md). + +#### `rclcpp` + +The `rclcpp` package provides the ROS client library in C++. + +It is **Quality Level 4**, see its [Quality Declaration document](https://github.com/ros2/rclcpp/blob/master/rclcpp/QUALITY_DECLARATION.md). + +#### `rcl_action` + +The `rcl_action` package provides C-based ROS action implementation. + +It is **Quality Level 4**, see its [Quality Declaration document](https://github.com/ros2/rcl/blob/master/rcl_action/QUALITY_DECLARATION.md). ### Direct Runtime non-ROS Dependency [5.iii] diff --git a/rclcpp_components/QUALITY_DECLARATION.md b/rclcpp_components/QUALITY_DECLARATION.md index 031316d..74e50d1 100644 --- a/rclcpp_components/QUALITY_DECLARATION.md +++ b/rclcpp_components/QUALITY_DECLARATION.md @@ -1,4 +1,4 @@ -This document is a declaration of software quality for the `rclcpp_components` package, based on the guidelines in [REP-2004](https://github.com/ros-infrastructure/rep/blob/rep-2004/rep-2004.rst). +This document is a declaration of software quality for the `rclcpp_components` package, based on the guidelines in [REP-2004](https://www.ros.org/reps/rep-2004.html). # `rclcpp_components` Quality Declaration @@ -137,16 +137,39 @@ Currently nightly test results can be seen here: ## Dependencies [5] +Below are evaluations of each of `rclcpp_components`'s run-time and build-time dependencies that have been determined to influence the quality. + +It has several "buildtool" dependencies, which do not affect the resulting quality of the package, because they do not contribute to the public library API. + +It also has several test dependencies, which do not affect the resulting quality of the package, because they are only used to build and run the test code. + ### Direct and Optional Runtime ROS Dependencies [5.i]/[5.ii] `rclcpp_components` has the following runtime ROS dependencies: - - ament_index_cpp - - class_loader - - composition_interfaces - - rclcpp -It has several "buildtool" dependencies, which do not affect the resulting quality of the package, because they do not contribute to the public library API. -It also has several test dependencies, which do not affect the resulting quality of the package, because they are only used to build and run the test code. +#### `ament_index_cpp` + +The `ament_index_cpp` package provides a C++ API to access the ament resource index. + +It is **Quality Level 4**, see its [Quality Declaration document](https://github.com/ament/ament_index/blob/master/ament_index_cpp/QUALITY_DECLARATION.md). + +#### `class_loader` + +The `class_loader` package provides a ROS-independent package for loading plugins during runtime + +It is **Quality Level 4**, see its [Quality Declaration document](https://github.com/ros/class_loader/blob/ros2/QUALITY_DECLARATION.md). + +#### `composition_interfaces` + +The `composition_interfaces` package contains message and service definitions for managing composable nodes in a container process. + +It is **Quality Level 4**, see its [Quality Declaration document](https://github.com/ros2/rcl_interfaces/blob/master/composition_interfaces/QUALITY_DECLARATION.md). + +#### `rclcpp` + +The `rclcpp` package provides the ROS client library in C++. + +It is **Quality Level 4**, see its [Quality Declaration document](https://github.com/ros2/rclcpp/blob/master/rclcpp/QUALITY_DECLARATION.md). ### Direct Runtime non-ROS Dependency [5.iii] diff --git a/rclcpp_lifecycle/QUALITY_DECLARATION.md b/rclcpp_lifecycle/QUALITY_DECLARATION.md index ac44888..afcc143 100644 --- a/rclcpp_lifecycle/QUALITY_DECLARATION.md +++ b/rclcpp_lifecycle/QUALITY_DECLARATION.md @@ -1,4 +1,4 @@ -This document is a declaration of software quality for the `rclcpp_lifecycle` package, based on the guidelines in [REP-2004](https://github.com/ros-infrastructure/rep/blob/rep-2004/rep-2004.rst). +This document is a declaration of software quality for the `rclcpp_lifecycle` package, based on the guidelines in [REP-2004](https://www.ros.org/reps/rep-2004.html). # `rclcpp_lifecycle` Quality Declaration @@ -135,16 +135,39 @@ Currently nightly test results can be seen here: ## Dependencies [5] +Below are evaluations of each of `rclcpp_lifecycle`'s run-time and build-time dependencies that have been determined to influence the quality. + +It has several "buildtool" dependencies, which do not affect the resulting quality of the package, because they do not contribute to the public library API. + +It also has several test dependencies, which do not affect the resulting quality of the package, because they are only used to build and run the test code. + ### Direct and Optional Runtime ROS Dependencies [5.i]/[5.ii] `rclcpp_lifecycle` has the following runtime ROS dependencies: - - lifecycle_msgs - - rclcpp - - rcl_lifecycle - - rosidl_typesupport_cpp -It has several "buildtool" dependencies, which do not affect the resulting quality of the package, because they do not contribute to the public library API. -It also has several test dependencies, which do not affect the resulting quality of the package, because they are only used to build and run the test code. +#### `lifecycle_msgs` + +The `lifecycle_msgs` package contains message and service definitions for managing lifecycle nodes. + +It is **Quality Level 4**, see its [Quality Declaration document](https://github.com/ros2/rcl_interfaces/blob/master/lifecycle_msgs/QUALITY_DECLARATION.md). + +#### `rclcpp` + +The `rclcpp` package provides the ROS client library in C++. + +It is **Quality Level 4**, see its [Quality Declaration document](https://github.com/ros2/rclcpp/blob/master/rclcpp/QUALITY_DECLARATION.md). + +#### `rcl_lifecycle` + +The `rcl_lifecycle` package provides functionality for ROS 2 lifecycle nodes in C. + +It is **Quality Level 4**, see its [Quality Declaration document](https://github.com/ros2/rcl/blob/master/rcl_lifecycle/QUALITY_DECLARATION.md). + +#### `rosidl_typesupport_cpp` + +The `rosidl_typesupport_cpp` package generates the type support for C++ messages. + +It is **Quality Level 4**, see its [Quality Declaration document](https://github.com/ros2/rosidl_typesupport/blob/master/rosidl_typesupport_cpp/QUALITY_DECLARATION.md). ### Direct Runtime non-ROS Dependency [5.iii]