From c834a5066d079bd8f554bab3fc463c0f32cdfb73 Mon Sep 17 00:00:00 2001
From: Adriaan de Groot <groot@kde.org>
Date: Sun, 5 Dec 2021 02:26:23 +0100
Subject: [PATCH] [umount] Make it much more clear that the logfiles-thing is
 going away.

---
 CHANGES-3.2                    |  6 ++++++
 src/modules/umount/main.py     |  1 +
 src/modules/umount/umount.conf | 18 +++++++++++-------
 3 files changed, 18 insertions(+), 7 deletions(-)

diff --git a/CHANGES-3.2 b/CHANGES-3.2
index b658191fb..566a61ed9 100644
--- a/CHANGES-3.2
+++ b/CHANGES-3.2
@@ -13,6 +13,9 @@ This release contains contributions from (alphabetically by first name):
  - Artem Grinev
  - Evan James
 
+Distributions are **specifically** reminded to update the *umount* module
+configuration (and to use *preservefiles* if needed).
+
 ## Core ##
  - Errors (e.g. when an installation fails for whatever reason) are displayed
    in a dialog with a scrollable details panel, rather than growing up
@@ -21,6 +24,9 @@ This release contains contributions from (alphabetically by first name):
 ## Modules ##
  - *partition* now supports "deep" btrfs subvolume names, e.g. a
    separate subvolume for `/usr/local`. (Thanks Evan)
+ - The *umount* module now warns if the "preserve log file" feature is used.
+   This has been deprecated for a long time: use the *preservefiles* module
+   instead. A future release will turn this into an error.
 
 
 # 3.2.48 (2021-12-03) #
diff --git a/src/modules/umount/main.py b/src/modules/umount/main.py
index 77ea91e34..5fdb36014 100644
--- a/src/modules/umount/main.py
+++ b/src/modules/umount/main.py
@@ -80,6 +80,7 @@ def run():
     if(libcalamares.job.configuration and
        "srcLog" in libcalamares.job.configuration and
        "destLog" in libcalamares.job.configuration):
+        libcalamares.utils.warning("Log-file preserving is **deprecated** in the *umount* module")
         log_source = libcalamares.job.configuration["srcLog"]
         log_destination = libcalamares.job.configuration["destLog"]
         # Relocate log_destination into target system
diff --git a/src/modules/umount/umount.conf b/src/modules/umount/umount.conf
index b6d86e353..062f7ac4b 100644
--- a/src/modules/umount/umount.conf
+++ b/src/modules/umount/umount.conf
@@ -10,16 +10,20 @@
 # The "copy log files" functionality is deprecated; use the *preservefiles*
 # module instead, which is more flexible.
 #
-# This module has two configuration keys:
-#   srcLog  location in the live system where the log is
-#   destLog location in the target system to copy the log
 #
 
 ---
-# example when using the normal Calamares log:
-srcLog:      "/root/.cache/calamares/session.log"
-destLog:     "/var/log/Calamares.log"
-
+# This is a **deprecated** example. Use the *preservefiles* module
+# instead, where the equivalent configuration is this:
+#
+# files:
+#   - from: log
+#     dest: /var/log/installation.log
+#
+# Note that the "equivalent configuration" always finds the log,
+# and is not dependent on specific user names or the vagaries of
+# polkit configuration -- so it is a **better** "equivalent".
+#
 # example when using a log created by `sudo calamares -d`:
 #srcLog:      "/home/live/installation.log"
 #destLog:     "/var/log/installation.log"