Repository navigation
Add XML Lifecycle Management guide (incl. C/C++ WIP/deprecated/superseded diagnostics) - #802
Open
hamishwillee wants to merge 2 commits into
Open
hamishwillee wants to merge 2 commits into
hamishwillee wants to merge 2 commits into
Conversation
New guide page explaining how MAVLink definitions move through development.xml / common.xml / standard.xml and the <wip>, <superseded> and <deprecated> lifecycle elements, and how C/C++ projects can get compile-time diagnostics for flagged definitions using the opt-in macros added in ArduPilot/pymavlink#1284. Adds the page to SUMMARY.md and links to it from the C and C++11 library pages and the XML schema "Lifecycle Elements" section. Adds compiler terms used on the page to the cspell word list. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The <wip> section said the generator toolchain can be configured to build messages omitting <wip> entries; no mavgen option does this. Replace it (and the matching commented-out <deprecated> line) with a pointer to the C/C++ compile-time diagnostics in the XML Lifecycle Management guide. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
hamishwillee
marked this pull request as ready for review
November 18, 2026 07:46
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.
@peterbarker This is how Claude thinks it works, along with my tweaks so I "think" I understand it. Please sanity check.
Adds a new guide page, XML Lifecycle Management, covering:
development.xml→common.xml→standard.xml, and the<wip>/<superseded>/<deprecated>elements. Includes a note on the stakeholder-agreement review gates at each step.The page is linked from
SUMMARY.md(Guide section), from the C and C++ 11 library pages, and from the XML schema "Lifecycle Elements" section.Commits
cspell.jsonword list.<wip>/<deprecated>: a separate wording fix. The<wip>section said the generator can be configured to omit WIP entries, but no mavgen option does this. The claim is replaced with a pointer to the diagnostics. The matching commented-out<deprecated>line is replaced the same way.Verification
e9ab78b6). Each produces the diagnostic the page describes. Builds without the macros stay clean under-Werror. The CMake release/dev snippet was also checked.yarn docs:buildpasses, andyarn linkcheckreports no issues on the changed pages.Note: mavlink/mavlink's pymavlink submodule and
c_library_v2don't include #1284 yet.🤖 Generated with Claude Code