Skip to content

Commit

Permalink
Non-common message XML files are called dialects
Browse files Browse the repository at this point in the history
  • Loading branch information
hamishwillee authored May 4, 2018
1 parent 78b095e commit 3893a6f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/mavlink_gitbook.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
#initialise text for index file.
index_text='<!-- THIS FILE IS AUTO-GENERATED (DO NOT UPDATE GITBOOK): https://github.com/mavlink/mavlink/blob/master/doc/mavlink_gitbook.py -->'
index_text+='\n# Message Definitions'
index_text+='\n\nMAVLink messages are defined in XML files in the [mavlink/message definitions](https://github.com/mavlink/mavlink/blob/master/message_definitions/) folder. The messages that are common to all systems are defined in [common.xml](https://github.com/mavlink/mavlink/blob/master/message_definitions/v1.0/common.xml) (only messages contained in this file are considered *standard* messages). MAVLink protocol-specific messages and vendor-specific messages are stored in separate XML files that can either *replace* or *extend* (include) the standard messages.'
index_text+='\n\nMAVLink messages are defined in XML files in the [mavlink/message definitions](https://github.com/mavlink/mavlink/blob/master/message_definitions/) folder. The messages that are common to all systems are defined in [common.xml](https://github.com/mavlink/mavlink/blob/master/message_definitions/v1.0/common.xml) (only messages contained in this file are considered *standard* messages). MAVLink protocol-specific messages and vendor-specific messages are referred to as "dialects" - these are stored in separate XML files that can either *replace* or *extend* (include) the standard messages.'
index_text+='\n\nThe common messages are provided as human-readable tables in: [Common](../messages/common.md).'
index_text+='\n\n> **Note** Vendor forks of MAVLink may contain messages that are not get merged, and hence will not appear in this documentation.'
index_text+='\n\nThe human-readable forms of the vendor XML files are linked below:'
Expand Down

0 comments on commit 3893a6f

Please sign in to comment.