AP_Common: AP_FWVersionDefine: Add comment about version number

Signed-off-by: Patrick José Pereira <patrickelectric@gmail.com>
This commit is contained in:
Patrick José Pereira 2022-02-10 06:47:28 -03:00 committed by Peter Barker
parent 759057347e
commit b2bd74f53c
1 changed files with 5 additions and 0 deletions

View File

@ -34,6 +34,11 @@
#define ORIGINAL_FWSTR nullptr #define ORIGINAL_FWSTR nullptr
#endif #endif
/**
* The version number should be used when the structure is updated
* Major: For breaking changes of the structure
* Minor: For new fields that does not brake the structure or corrections
*/
const AP_FWVersion AP_FWVersion::fwver{ const AP_FWVersion AP_FWVersion::fwver{
// Version header struct // Version header struct
.header = 0x61706677766572fb, // First 7 MSBs: "apfwver", LSB is the checksum of the previous string: 0xfb .header = 0x61706677766572fb, // First 7 MSBs: "apfwver", LSB is the checksum of the previous string: 0xfb