[neon/neon/calamares-settings/Neon/release-lts] /: clarify the difference between undo and cleanup

[Harald Sitter]

Git commit cd3fafcb0473c3975e60b9c12e105b7c6d657bdf by Harald Sitter.
Committed on 15/03/2021 at 13:26.
Pushed by sitter into branch 'Neon/release-lts'.

clarify the difference between undo and cleanup

it wasn't quite obvious from just glancing at

M  +10   -1    oem-config/calamares/oem-config/modules/undo-oem.conf
M  +2    -1    oem-prepare/calamares/oem-prepare/prepare-system/oem-cleanup

https://invent.kde.org/neon/neon/calamares-settings/commit/cd3fafcb0473c3975e60b9c12e105b7c6d657bdf

diff --git a/oem-config/calamares/oem-config/modules/undo-oem.conf b/oem-config/calamares/oem-config/modules/undo-oem.conf
index 9cf32df..33dbbe7 100644
--- a/oem-config/calamares/oem-config/modules/undo-oem.conf
+++ b/oem-config/calamares/oem-config/modules/undo-oem.conf
@@ -1,5 +1,14 @@
-# SPDX-FileCopyrightText: 2018-2019 Harald Sitter <sitter at kde.org>
+# SPDX-FileCopyrightText: 2018-2021 Harald Sitter <sitter at kde.org>
 # SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
+# This cleans up OEM alterations. This is run as part of the oem-config
+# calamares and somewhat overlaps with the oem-cleanup service. The latter
+# is specifically meant to run after oem-config has completedly entirely as it
+# will (among other things) nuke the oem user, meaning it cannot run until
+# we no longer need any processes.
+# Undo is primarily for changes which MUST happen before we hand over to
+# the final user (notably undo of kdeglobals lockout and sddm autologin).
+# There may be overlap. Generally oem-cleanup should be preferred as it can run
+# concurrently with sddm and the final session.
 ---
 timeout: 1800
 script:
diff --git a/oem-prepare/calamares/oem-prepare/prepare-system/oem-cleanup b/oem-prepare/calamares/oem-prepare/prepare-system/oem-cleanup
index 4ea5f0b..dd9f9a5 100755
--- a/oem-prepare/calamares/oem-prepare/prepare-system/oem-cleanup
+++ b/oem-prepare/calamares/oem-prepare/prepare-system/oem-cleanup
@@ -1,11 +1,12 @@
 #!/bin/sh
-# SPDX-FileCopyrightText: 2018 Harald Sitter <sitter at kde.org>
+# SPDX-FileCopyrightText: 2018-2021 Harald Sitter <sitter at kde.org>
 # SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
 
 set -ex
 
 # This is part of oem-config-firstboot. Since we run cala through the oem user
 # there is more cleanup we need to do after the oem configuration is done though
+# and the user is no longer needed to run any programs.
 
 # Remove the temporary OEM configuration user, if possible
 # and desired.