add API Version Management under Ament CMake page. #6116
Merged
Conversation
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
Signed-off-by: Tomoya.Fujita <[email protected]>
fujitatomoya
added
the
backport-all
fujitatomoya
commented
Dec 26, 2025
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for API Version Management to the Ament CMake page. The new section explains how to use ament_generate_version_header for managing API versions in C/C++ packages through compile-time macros, which is useful for maintaining backward compatibility across different ROS 2 distributions and patch releases.
Key changes:
- Documentation of auto-generated version macros and their naming conventions
- Instructions for generating version headers in user packages
- Best practices for using version macros for API compatibility checking
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
HTML artifacts: https://github.com/ros2/ros2_documentation/actions/runs/20519103241/artifacts/4970003841. To view the resulting site:
|
ahcorde
approved these changes
Dec 26, 2025
fujitatomoya
deleted the
fujitatomoya/ament-api-version-generated-macros
branch
mergify bot
pushed a commit
that referenced
this pull request
Dec 27, 2025
Signed-off-by: Tomoya.Fujita <[email protected]> (cherry picked from commit d40b914)
mergify bot
pushed a commit
that referenced
this pull request
Dec 27, 2025
Signed-off-by: Tomoya.Fujita <[email protected]> (cherry picked from commit d40b914)
mergify bot
pushed a commit
that referenced
this pull request
Dec 27, 2025
Signed-off-by: Tomoya.Fujita <[email protected]> (cherry picked from commit d40b914)
This was referenced Dec 27, 2025
fujitatomoya
added a commit
that referenced
this pull request
Dec 27, 2025
(cherry picked from commit d40b914) Signed-off-by: Tomoya.Fujita <[email protected]> Co-authored-by: Tomoya Fujita <[email protected]>
fujitatomoya
added a commit
that referenced
this pull request
Dec 27, 2025
(cherry picked from commit d40b914) Signed-off-by: Tomoya.Fujita <[email protected]> Co-authored-by: Tomoya Fujita <[email protected]>
fujitatomoya
added a commit
that referenced
this pull request
Dec 27, 2025
(cherry picked from commit d40b914) Signed-off-by: Tomoya.Fujita <[email protected]> Co-authored-by: Tomoya Fujita <[email protected]>
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
Fixes #6115
Did you use Generative AI?
Yes, Claude Sonnet 4.5
Additional Information