3di | Add area and related_scope metadata for related packages lists - #3309
Open
kacperbojakowski-3di wants to merge 1 commit into
Open
kacperbojakowski-3di wants to merge 1 commit into
kacperbojakowski-3di wants to merge 1 commit into
Conversation
Signed-off-by: Kacper Bojakowski <kacper.bojakowski@3di-info.com>
ABI Compliance Check✅ Verdict: compatible
✅
|
Collaborator
|
I don't like the approach for several reasons.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Adds
<area>and<related_scope>torclcpp'spackage.xmlso the related packages lists in #7240 can match this package. Those lists read exports from the rosdistro cache. Nothing released declares them yet, so the lists are empty. This is one core package as a worked example.Metadata added
In the existing
<export>ofrclcpp/package.xml:<area>: which docs pages list the package (most specific first).<related_scope>:coreorfederation(missing is treated as community).Why these values
client-libraries, frameworkmatches docs pages that already use:area: client-libraries, framework.coreputs it under Core ROS packages rather than community.Why this is safe to add
<export>is the passthrough container for tool-specific metadata, and tools are expected to skip any export tags they don't recognise (REP 140). Nothing in the build reads these two, so there's no effect on howrclcppcompiles or runs, and no ABI impact. This is all just for the docs.Scope and next steps
Limited to
rclcppon purpose, as an example to look at before this goes wider. I'll be adding the same exports to the other core packages. Each one shows up in the docs after relase and cache refresh.Dependencies
Visible to users once #7240 and #6981 land, and this
rclcppchange is released (docs read the released cache, not source).Changes
rclcpp/package.xml: add<area>client-libraries, framework</area>and<related_scope>core</related_scope>.Additional Information
Issue: #6991