Mirror
/
ardupilot
mirror of https://github.com/ArduPilot/ardupilot
5
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

APM: added longer comment on k_format_version

This commit is contained in:
Andrew Tridgell 2012-06-15 11:54:13 +10:00
parent 3b07f8c06a
commit 3a9096aa41
1 changed files with 27 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
ArduPlane/Parameters.h
View File

@ -9,15 +9,34 @@
//
class Parameters {
public:
// The version of the layout as described by the parameter enum.
//
// When changing the parameter enum in an incompatible fashion, this
// value should be incremented by one.
//
// The increment will prevent old parameters from being used incorrectly
// by newer code.
//
/*
The value of k_format_version determines whether the existing
eeprom data is considered valid. You should only change this
value under the following circumstances:
1) the meaning of an existing eeprom parameter changes
2) the value of an existing k_param_* enum value changes
Adding a new parameter should _not_ require a change to
k_format_version except under special circumstances. If you
change it anyway then all ArduPlane users will need to reload all
their parameters. We want that to be an extremely rare
thing. Please do not just change it "just in case".
To determine if a k_param_* value has changed, use the rules of
C++ enums to work out the value of the neighboring enum
values. If you don't know the C++ enum rules then please ask for
help.
*/
//////////////////////////////////////////////////////////////////
// STOP!!! DO NOT CHANGE THIS VALUE UNTIL YOU FULLY UNDERSTAND THE
// COMMENTS ABOVE. IF UNSURE, ASK ANOTHER DEVELOPER!!!
static const uint16_t k_format_version = 13;
//////////////////////////////////////////////////////////////////
// The parameter software_type is set up solely for ground station use
// and identifies the software type (eg ArduPilotMega versus ArduCopterMega)