diff --git a/rcl/QUALITY_DECLARATION.md b/rcl/QUALITY_DECLARATION.md index cef37a7d6..5d60d4cfd 100644 --- a/rcl/QUALITY_DECLARATION.md +++ b/rcl/QUALITY_DECLARATION.md @@ -67,7 +67,7 @@ All pull requests must resolve related documentation changes before merging. ### Feature Documentation [3.i] -`rcl` provides the main elements of its API listed using doxygen. Refer to the [ROS2 concepts](https://docs.ros.org/en/rolling/Concepts.html) and [ROS2 Client Libraries](https://docs.ros.org/en/rolling/Concepts/About-ROS-2-Client-Libraries.html) pages for reference of elements covered by this package. +`rcl` provides the main elements of its API listed using doxygen. Refer to the [ROS 2 concepts](https://docs.ros.org/en/rolling/Concepts.html) and [ROS 2 Client Libraries](https://docs.ros.org/en/rolling/Concepts/About-ROS-2-Client-Libraries.html) pages for reference of elements covered by this package. ### Public API Documentation [3.ii] @@ -130,7 +130,7 @@ Changes that introduce regressions in performance must be adequately justified i ### Linters and Static Analysis [4.v] -`rcl` uses and passes all the ROS2 standard linters and static analysis tools for a C++ package as described in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/Contributing/Developer-Guide.html#linters-and-static-analysis). Passing implies there are no linter/static errors when testing against CI of supported platforms. +`rcl` uses and passes all the ROS 2 standard linters and static analysis tools for a C++ package as described in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/Contributing/Developer-Guide.html#linters-and-static-analysis). Passing implies there are no linter/static errors when testing against CI of supported platforms. Currently nightly test results can be seen here: * [linux-aarch64_release](https://ci.ros2.org/view/nightly/job/nightly_linux-aarch64_release/lastBuild/testReport/rcl/) @@ -151,49 +151,49 @@ It also has several test dependencies, which do not affect the resulting quality The `rmw` package provides the API used by `rcl` to interact with the underlying middleware in an abstract way. -It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rmw/blob/master/rmw/QUALITY_DECLARATION.md). +It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rmw/blob/rolling/rmw/QUALITY_DECLARATION.md). #### `rcl_interfaces` The `rcl_interfaces` package provides some common ROS Message and ROS Service types which are used to implement certain client library features. -It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rcl_interfaces/blob/master/rcl_interfaces/QUALITY_DECLARATION.md). +It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rcl_interfaces/blob/rolling/rcl_interfaces/QUALITY_DECLARATION.md). #### `rcl_logging_spdlog` The `rcl_logging_spdlog` package provides the default logging implementation by wrapping the `spdlog` library. -It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rcl_logging/blob/master/rcl_logging_spdlog/QUALITY_DECLARATION.md). +It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rcl_logging/blob/rolling/rcl_logging_spdlog/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 1**, see its [Quality Declaration document](https://github.com/ros2/rcl/blob/master/rcl_yaml_param_parser/QUALITY_DECLARATION.md). +It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rcl/blob/rolling/rcl_yaml_param_parser/QUALITY_DECLARATION.md). #### `rcutils` The `rcutils` package provides an API which contains common utilities and data structures needed when programming in C. -It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rcutils/blob/master/QUALITY_DECLARATION.md). +It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rcutils/blob/rolling/QUALITY_DECLARATION.md). #### `rmw_implementation` The `rmw_implementation` package provides access to the default rmw implementation, and provides the ability to dynamically switch rmw implementations if more than one is available. -It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rmw_implementation/blob/master/rmw_implementation/QUALITY_DECLARATION.md). +It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rmw_implementation/blob/rolling/rmw_implementation/QUALITY_DECLARATION.md). #### `rosidl_runtime_c` The `rosidl_runtime_c` package provides runtime interfaces in C based on user defined ROS Messages and ROS Services, as well as associated support functions for those types. -It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rosidl/blob/master/rosidl_runtime_c/QUALITY_DECLARATION.md). +It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rosidl/blob/rolling/rosidl_runtime_c/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 1**, see its [Quality Declaration document](https://gitlab.com/ros-tracing/ros2_tracing/-/blob/master/tracetools/QUALITY_DECLARATION.md). +It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/ros2_tracing/blob/rolling/tracetools/QUALITY_DECLARATION.md). ### Optional Direct Runtime ROS Dependencies [5.ii] diff --git a/rcl_action/QUALITY_DECLARATION.md b/rcl_action/QUALITY_DECLARATION.md index d3e1c0636..649a13096 100644 --- a/rcl_action/QUALITY_DECLARATION.md +++ b/rcl_action/QUALITY_DECLARATION.md @@ -143,7 +143,7 @@ It also has several test dependencies, which do not affect the resulting quality `action_msgs` provides messages and services for ROS 2 actions. -It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rcl_interfaces/blob/master/action_msgs/QUALITY_DECLARATION.md). +It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rcl_interfaces/blob/rolling/action_msgs/QUALITY_DECLARATION.md). #### `rcl` @@ -155,19 +155,19 @@ It is **Quality Level 1**, see its [Quality Declaration document](../rcl/QUALITY `rcutils` provides commonly used functionality in C. -It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rcutils/blob/master/QUALITY_DECLARATION.md). +It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rcutils/blob/rolling/QUALITY_DECLARATION.md). #### `rmw` `rmw` is the ROS 2 middleware library. -It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rmw/blob/master/rmw/QUALITY_DECLARATION.md). +It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rmw/blob/rolling/rmw/QUALITY_DECLARATION.md). #### `rosidl_runtime_c` `rosidl_runtime_c` provides runtime functionality for rosidl message and service interfaces. -It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rosidl/blob/master/rosidl_runtime_c/QUALITY_DECLARATION.md). +It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rosidl/blob/rolling/rosidl_runtime_c/QUALITY_DECLARATION.md). ### Direct Runtime Non-ROS Dependencies [5.iii] diff --git a/rcl_lifecycle/QUALITY_DECLARATION.md b/rcl_lifecycle/QUALITY_DECLARATION.md index fa5024226..4eb50686f 100644 --- a/rcl_lifecycle/QUALITY_DECLARATION.md +++ b/rcl_lifecycle/QUALITY_DECLARATION.md @@ -144,7 +144,7 @@ It also has several test dependencies, which do not affect the resulting quality `lifecycle_msgs` provides message and services for managing lifecycle nodes. -It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rcl_interfaces/blob/master/lifecycle_msgs/QUALITY_DECLARATION.md). +It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rcl_interfaces/blob/rolling/lifecycle_msgs/QUALITY_DECLARATION.md). #### `rcl` @@ -156,25 +156,25 @@ It is **Quality Level 1**, see its [Quality Declaration document](../rcl/QUALITY `rcutils` provides commonly used functionality in C. -It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rcutils/blob/master/QUALITY_DECLARATION.md). +It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rcutils/blob/rolling/QUALITY_DECLARATION.md). #### `rmw` `rmw` is the ROS 2 middleware library. -It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rmw/blob/master/rmw/QUALITY_DECLARATION.md). +It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rmw/blob/rolling/rmw/QUALITY_DECLARATION.md). #### `rosidl_runtime_c` `rosidl_runtime_c` provides runtime functionality for rosidl message and service interfaces. -It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rosidl/blob/master/rosidl_runtime_c/QUALITY_DECLARATION.md). +It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rosidl/blob/rolling/rosidl_runtime_c/QUALITY_DECLARATION.md). #### `tracetools` The `tracetools` package provides utilities for instrumenting the code in `rcl_lifecycle` so that it may be traced for debugging and performance analysis. -It is **Quality Level 1**, see its [Quality Declaration document](https://gitlab.com/ros-tracing/ros2_tracing/-/blob/master/tracetools/QUALITY_DECLARATION.md). +It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/ros2_tracing/blob/rolling/tracetools/QUALITY_DECLARATION.md). ### Direct Runtime Non-ROS Dependencies [5.iii] diff --git a/rcl_yaml_param_parser/QUALITY_DECLARATION.md b/rcl_yaml_param_parser/QUALITY_DECLARATION.md index 2a24ee690..db2e351c7 100644 --- a/rcl_yaml_param_parser/QUALITY_DECLARATION.md +++ b/rcl_yaml_param_parser/QUALITY_DECLARATION.md @@ -116,7 +116,7 @@ Current coverage statistics can be viewed [here](https://ci.ros2.org/job/nightly `rcl_yaml_param_parser` follows the recommendations for performance testing of C/C++ code in the [ROS 2 Developer Guide](https://docs.ros.org/en/rolling/Contributing/Developer-Guide.html#performance), and opts to do performance analysis on each release rather than each change. -The performance tests of `rcl_yaml_param_parser` are located in the [test/benchmark directory](https://github.com/ros2/rcl/tree/master/rcl_yaml_param_parser/test/benchmark). +The performance tests of `rcl_yaml_param_parser` are located in the [test/benchmark directory](https://github.com/ros2/rcl/tree/rolling/rcl_yaml_param_parser/test/benchmark). Package and system level performance benchmarks that cover features of `rcl_yaml_param_parser` can be found at: * [Benchmarks](http://build.ros2.org/view/Rci/job/Rci__benchmark_ubuntu_focal_amd64/BenchmarkTable/) @@ -143,13 +143,13 @@ It also has several test dependencies, which do not affect the resulting quality `rcutils` provides commonly used functionality in C. -It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rcutils/blob/master/QUALITY_DECLARATION.md). +It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/rcutils/blob/rolling/QUALITY_DECLARATION.md). #### `libyaml_vendor` `libyaml_vendor` is a vendor package for the libyaml C library. -It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/libyaml_vendor/blob/master/QUALITY_DECLARATION.md). +It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/libyaml_vendor/blob/rolling/QUALITY_DECLARATION.md). ### Direct Runtime Non-ROS Dependencies [5.iii] @@ -159,7 +159,7 @@ It is **Quality Level 1**, see its [Quality Declaration document](https://github `libyaml` is a YAML parsing library written in C. -It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/libyaml_vendor/blob/master/libyaml_q_declaration.md). +It is **Quality Level 1**, see its [Quality Declaration document](https://github.com/ros2/libyaml_vendor/blob/rolling/libyaml_q_declaration.md). ## Platform Support [6] diff --git a/rcl_yaml_param_parser/README.md b/rcl_yaml_param_parser/README.md index 04c8bd701..4ddf9795c 100644 --- a/rcl_yaml_param_parser/README.md +++ b/rcl_yaml_param_parser/README.md @@ -1,4 +1,4 @@ -# ROS2 rcl YAML parameter parser +# ROS 2 rcl YAML parameter parser Parse a YAML parameter file and populate the C data structure.