From 99bf5497cab76c029319b1c11b317ecef9ae6655 Mon Sep 17 00:00:00 2001
From: Adriaan de Groot <groot@kde.org>
Date: Mon, 11 Apr 2022 10:14:32 +0200
Subject: [PATCH] [users] Document change to config, document TODO:3.3

---
 CHANGES-3.2                  | 4 +++-
 src/modules/users/Config.cpp | 2 ++
 src/modules/users/users.conf | 4 ++++
 3 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/CHANGES-3.2 b/CHANGES-3.2
index ea8beb764..8cec4bb78 100644
--- a/CHANGES-3.2
+++ b/CHANGES-3.2
@@ -17,7 +17,9 @@ This release contains contributions from (alphabetically by first name):
  - No core changes yet
 
 ## Modules ##
- - No module changes yet
+ - *users* module has rearranged configuration for setting the hostname.
+   Legacy settings are preserved, but produce a warning. Please see
+   `users.conf` for details.
 
 
 # 3.2.54 (2022-03-21) #
diff --git a/src/modules/users/Config.cpp b/src/modules/users/Config.cpp
index 55377abba..6cc3a0cea 100644
--- a/src/modules/users/Config.cpp
+++ b/src/modules/users/Config.cpp
@@ -826,6 +826,7 @@ either( T ( *f )( const QVariantMap&, const QString&, U ),
     }
 }
 
+// TODO:3.3: Remove
 static void
 copyLegacy( const QVariantMap& source, const QString& sourceKey, QVariantMap& target, const QString& targetKey )
 {
@@ -860,6 +861,7 @@ Config::setConfigurationMap( const QVariantMap& configurationMap )
         bool ok = false;  // Ignored
         QVariantMap hostnameSettings = CalamaresUtils::getSubMap( configurationMap, "hostname", ok );
 
+        // TODO:3.3: Remove calls to copyLegacy
         copyLegacy( configurationMap, "setHostname", hostnameSettings, "location" );
         copyLegacy( configurationMap, "writeHostsFile", hostnameSettings, "writeHostsFile" );
         m_hostNameActions = getHostNameActions( hostnameSettings );
diff --git a/src/modules/users/users.conf b/src/modules/users/users.conf
index 397b888cc..22e7e0a68 100644
--- a/src/modules/users/users.conf
+++ b/src/modules/users/users.conf
@@ -171,10 +171,14 @@ hostname:
   location: EtcFile
   writeHostsFile: true
 
+# TODO:3.3: Remove this setting
+#
 # This is a legacy setting for hostname.location; if it is set
 # at all, and there is no setting for hostname.location, it is used.
 setHostname: EtcFile
 
+# TODO:3.3: Remove this setting
+#
 # This is a legacy setting for hostname.writeHostsFile
 writeHostsFile: true