docs(msgs): drop stale system-ROS discovery fallback from message-generation docs - #353
Open
YuanYuYuan wants to merge 1 commit into
Open
YuanYuYuan wants to merge 1 commit into
YuanYuYuan wants to merge 1 commit into
Conversation
…eration docs #344 removed hiroz-msgs' system ROS 2 discovery (AMENT_PREFIX_PATH, CMAKE_PREFIX_PATH, /opt/ros/*) in favor of bundled-assets-only generation selected by distro feature, hard-erroring on a missing package instead of falling back. The docs still described the old 3-tier search order (system install -> standard paths -> bundled assets) across building.md, message-generation.md (two mermaid diagrams) and troubleshooting.md, plus one discovery-flow diagram in python-codegen.md. Update all of them to describe the actual behavior: bundled-assets-only, selected by distro feature, missing package is a build error.
|
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
1 participant
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.
Summary
#344 replaced
hiroz-msgs' package discovery (system ROS install probing + bundled-assets fallback) with bundled-assets-only generation, selected by aDistroCargo feature. The docs describing message generation were not updated and still describe the old, no-longer-existing discovery path.Before and after
AMENT_PREFIX_PATH/CMAKE_PREFIX_PATH) → 2./opt/ros/{distro}→ 3. bundled assetshumble/jazzy/lyricaldistro feature$AMENT_PREFIX_PATH,ros2 pkg prefixassets/<distro>/What this PR does
docs/getting-started/building.md— replace the 3-tier "Message Package Resolution" search order with the actual bundled-only behavior.docs/user-guide/message-generation.md— rewrite the discovery-workflow sequence diagram and the "Package Discovery Order" flowchart + list to match; both previously showed a system-ROS-first search.docs/reference/troubleshooting.md— replace the "package not found / missing ROS 2 packages" entry (which told readers to source ROS 2 and checkAMENT_PREFIX_PATH) with guidance for the actual failure mode: an enabled package feature has no matching package in the selected distro's bundled asset tree.docs/bindings/python-codegen.md— fix one discovery-flow diagram node that still said(AMENT_PREFIX_PATH or bundled).No code changes.
What fails without this
No test failure — this is a documentation-accuracy fix. Before this PR, following the troubleshooting doc's advice (source ROS 2, check
AMENT_PREFIX_PATH) for ahiroz-msgsbuild failure does nothing, becausehiroz-msgsnever reads those variables after #344.Breaking Changes
None.