Skip to content

Reserved MAV_CMD params are not declared (NaN/INT32_MAX sentinels) - #800

Merged
hamishwillee merged 4 commits into
mavlink:masterfrom
hamishwillee:reserved-params-not-declared
Nov 12, 2026
Merged

hamishwillee merged 4 commits into
mavlink:masterfrom
hamishwillee:reserved-params-not-declared

Conversation

@hamishwillee

@hamishwillee hamishwillee commented Nov 12, 2026 •

Copy link
Copy Markdown
Collaborator

This updates the devguide so that it correctly notes how to "reserve" params, and what their default values should be set to.


mavlink/mavlink#2629 removed all reserved <param> declarations from common.xml: an unused MAV_CMD param is now reserved by omission, and the generators document it as `Reserved. Default: NaN.` (params 1-4, 7) or `Reserved. Default: INT32_MAX (COMMAND_INT/MISSION_ITEM_INT) or NaN (COMMAND_LONG).` (params 5, 6).

This aligns the devguide with that:

  • define_xml_element.md#reserved: all unused params are reserved and not declared. Adds MISSION_ITEM_INT to the sentinel list, replaces the uncited ArduPilot claim with the "planning to migrate" note used in the generated docs, replaces the reserved="true" default="NaN" example with the real MAV_CMD_DO_JUMP entry, and notes which declared params the toolchain still treats as reserved (reserved="true", blank, or text starting Reserved/Empty/Unused/Not used/N/A/Spare).
  • xml_schema.md <param>: unused params must not be declared; `reserved` marked do-not-use; `default` marked unused/deprecated (no generator uses it); removes the old sentinel declaration guidance.
  • xml_schema.md example: MAV_CMD_NAV_PAYLOAD_PLACE updated to match current XML.
  • command.md: drops "reserve params 5 and 6 with a default value of `0`".

Follow-up for mavlink/mavlink: MAV_CMD_DO_ORBIT param 4 and MAV_CMD_OBLIQUE_SURVEY params 2, 3, 5, 6 still declare default="0" (and DO_ORBIT's default conflicts with its "NaN: Use vehicle default" text).

Checked: yarn docs:build passes; yarn linkcheck output unchanged from master.

🤖 Generated with Claude Code

hamishwillee and others added 4 commits November 12, 2026 15:56
Unused MAV_CMD params are now reserved by omission (mavlink/mavlink#2629).
Replace the reserved="true" declaration example with MAV_CMD_DO_JUMP, add
MISSION_ITEM_INT to the sentinel list, drop the uncited ArduPilot claim, and
note which declared params the toolchain still treats as reserved.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Mark the param reserved attribute as do-not-use and the param default
attribute as unused/deprecated (no generator uses it), and remove the
reserved="true" default="NaN" sentinel guidance (sentinels are
documented in define_xml_element#reserved).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Unused params 2-4 are no longer declared, and params 5-7 use the
Latitude/X, Longitude/Y, Altitude/Z labels and descriptions.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Reserved MAV_CMD params use NaN/INT32_MAX sentinels, not 0; link to
define_xml_element#reserved for the values.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@hamishwillee
hamishwillee merged commit 203df06 into mavlink:master Nov 12, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant