From: Shane Synan <digitalcircuit36939@gmail.com>
Date: Sat, 7 Jan 2017 01:16:31 +0000 (-0600)
Subject: Clarify settings migration logic comments
X-Git-Tag: travis-deploy-test~313
X-Git-Url: https://git.quassel-irc.org/?p=quassel.git;a=commitdiff_plain;h=c9c0a48239303d241b76b96ea36c505f0b5bb945

Clarify settings migration logic comments

Add comments clarifying use of VERSION_MINOR_CURRENT in
migrateSettings() and the switch statements in
applySettingsMigration().  It's easy enough to do one and miss the
other as they're not very close by.

(I should've commented this in the first place.  Pardon!)

Resolves GH-269.
---

diff --git a/src/qtui/qtuiapplication.cpp b/src/qtui/qtuiapplication.cpp
index 2b6b58c8..8120aed2 100644
--- a/src/qtui/qtuiapplication.cpp
+++ b/src/qtui/qtuiapplication.cpp
@@ -210,6 +210,9 @@ bool QtUiApplication::migrateSettings()
     // --------
     // Check minor settings version, handling upgrades/downgrades as needed
     // Current minor version
+    //
+    // NOTE:  If you increase the minor version, you MUST ALSO add new version upgrade logic in
+    // applySettingsMigration()!  Otherwise, settings upgrades will fail.
     const uint VERSION_MINOR_CURRENT = 6;
     // Stored minor version
     uint versionMinor = s.versionMinor();
@@ -273,6 +276,8 @@ bool QtUiApplication::applySettingsMigration(QtUiSettings settings, const uint n
     //
     // In most cases, the goal is to preserve the older default values for keys that haven't been
     // saved.  Exceptions will be noted below.
+    // NOTE:  If you add new upgrade logic here, you MUST ALSO increase VERSION_MINOR_CURRENT in
+    // migrateSettings()!  Otherwise, your upgrade logic won't ever be called.
     case 6:
     {
         // New default changes: sender colors switched around to Tango-ish theme