Skip to content

Document that cross-distro communications are not guaranteed#5640

Merged
christophebedard merged 1 commit intorollingfrom
christophebedard/document-no-cross-distro-guarantee
May 20, 2025
Merged

Document that cross-distro communications are not guaranteed#5640
christophebedard merged 1 commit intorollingfrom
christophebedard/document-no-cross-distro-guarantee

Conversation

@christophebedard
Copy link
Copy Markdown
Member

Description

Relates to #3288. #4736 (which closed #3288) added a section about cross-rmw vendor communications not being guaranteed. #3288 also mentioned cross-distro communications, but it was not documented.

This new Discourse post is asking about cross-distro (in)compatibility: https://discourse.ros.org/t/incompatability-between-distributions/43747. We've talked about it not being guaranteed many times before, but I don't think it's mentioned anywhere in the docs (but I could be wrong). Since it's about multiple distros and not a specific distro, it's hard to find a place to document this, but I think the main distributions/releases page works well. I'm open to other suggestions, though.

Did you use Generative AI?

no

Additional Information

Signed-off-by: Christophe Bedard <bedard.christophe@gmail.com>
@christophebedard christophebedard added the backport-all backport at reviewers discretion; from rolling to all versions label May 20, 2025
@github-actions
Copy link
Copy Markdown

HTML artifacts: https://github.com/ros2/ros2_documentation/actions/runs/15126110217/artifacts/3156020876.

To view the resulting site:

  1. Click on the above link to download the artifacts archive
  2. Extract it
  3. Open html-artifacts-5640/index.html in your favorite browser

Comment on lines +208 to +215

Cross-Distribution Communications
---------------------------------

Nodes are not guaranteed to be able to communicate across distributions.
For example, a node built & running against Humble is not guaranteed to be able to communicate correctly with a node built & running against Iron.
It may or may not work, but it is not supported and should not be relied upon.
Note that :ref:`cross-vendor (single-distro) communications are also not guaranteed <different-middleware-vendors-cross-vendor-communication>`.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

The exact language could be changed. I also intentionally didn't get into why it may or may not work and why it's not supported, but I'm open to mentioning something specific.

Copy link
Copy Markdown
Collaborator

@fujitatomoya fujitatomoya left a comment

Choose a reason for hiding this comment

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

lgtm 👍

@christophebedard
Copy link
Copy Markdown
Member Author

Alright, thanks for the review. Let's go with this now, and we can always change it later.

@christophebedard christophebedard merged commit eed8fda into rolling May 20, 2025
5 checks passed
@christophebedard christophebedard deleted the christophebedard/document-no-cross-distro-guarantee branch May 20, 2025 18:02
mergify bot pushed a commit that referenced this pull request May 20, 2025
Signed-off-by: Christophe Bedard <bedard.christophe@gmail.com>
(cherry picked from commit eed8fda)
mergify bot pushed a commit that referenced this pull request May 20, 2025
Signed-off-by: Christophe Bedard <bedard.christophe@gmail.com>
(cherry picked from commit eed8fda)
mergify bot pushed a commit that referenced this pull request May 20, 2025
Signed-off-by: Christophe Bedard <bedard.christophe@gmail.com>
(cherry picked from commit eed8fda)
christophebedard added a commit that referenced this pull request May 20, 2025
…5645)

(cherry picked from commit eed8fda)

Signed-off-by: Christophe Bedard <bedard.christophe@gmail.com>
Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com>
christophebedard added a commit that referenced this pull request May 20, 2025
…5646)

(cherry picked from commit eed8fda)

Signed-off-by: Christophe Bedard <bedard.christophe@gmail.com>
Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com>
christophebedard added a commit that referenced this pull request May 20, 2025
…5647)

(cherry picked from commit eed8fda)

Signed-off-by: Christophe Bedard <bedard.christophe@gmail.com>
Co-authored-by: Christophe Bedard <bedard.christophe@gmail.com>
@ros-discourse
Copy link
Copy Markdown

This pull request has been mentioned on ROS Discourse. There might be relevant details there:

https://discourse.ros.org/t/announcement-intel-realsense-d555-with-native-ros-2-support-powered-by-safe-dds/44084/2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-all backport at reviewers discretion; from rolling to all versions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Cross-Distro/Vendor communication in ROS 2

3 participants