annotate Documentations/GPL_template.txt @ 319:d8e86af78474 fix-version

bugfix: correct packed main version number in dive header This fixes a rather mysterious bug. Users report that up to 1.3.5 beta, a correct version number is shown in libdivecomputer based applications (like in Subsurface, in the extra data tab). Careful examining the code in both libdivecomputer and the firmware shows a subtle error in the bit mask and shift operation to pack a full X.Y.Z.beta version number in 2 bytes (as is available in the dive header) in the firmware end (as the libdivecomputer code looks sane, assuming this is the right way to pack things). Likely, this bug crept in in the conversion from the closed source Keil period into the open source GCC setup of the code base. So its impossible to document the exact history of this problem here. Further notice that the main version number is only 1 of 3 version numbers, denoting the full version of the firmware (besides Font and RTE). Finally notice that this way of packing is limited to 2^5 bits (decimal 32), so we could easily build a 1.4.21, but not a 1.4.55. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
author Jan Mulder <jlmulder@xs4all.nl>
date Wed, 19 Jun 2019 14:31:50 +0200
parents 6237372f76a4
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
29
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
1 ///////////////////////////////////////////////////////////////////////////////
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
2 /// -*- coding: UTF-8 -*-
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
3 ///
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
4 /// \file $file
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
5 /// \brief $brief
35
6237372f76a4 ... more GPL License and general cleanups
jDG@sauge
parents: 31
diff changeset
6 /// \author Heinrichs Weikamp gmbh
29
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
7 /// \date $date
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
8 ///
31
da118222e18b [ADD]Discovery/Src licences, plus reindentation
jDG@sauge
parents: 29
diff changeset
9 /// \details
da118222e18b [ADD]Discovery/Src licences, plus reindentation
jDG@sauge
parents: 29
diff changeset
10 ///
29
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
11 /// $Id$
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
12 ///////////////////////////////////////////////////////////////////////////////
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
13 /// \par Copyright (c) 2014-2018 Heinrichs Weikamp gmbh
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
14 ///
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
15 /// This program is free software: you can redistribute it and/or modify
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
16 /// it under the terms of the GNU General Public License as published by
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
17 /// the Free Software Foundation, either version 3 of the License, or
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
18 /// (at your option) any later version.
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
19 ///
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
20 /// This program is distributed in the hope that it will be useful,
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
21 /// but WITHOUT ANY WARRANTY; without even the implied warranty of
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
22 /// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
23 /// GNU General Public License for more details.
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
24 ///
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
25 /// You should have received a copy of the GNU General Public License
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
26 /// along with this program. If not, see <http://www.gnu.org/licenses/>.
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
27 //////////////////////////////////////////////////////////////////////////////