[neon/neon/calamares-settings/Neon/release-lts] desktop/calamares/desktop/modules: refine docs of displaymanager a tad

[Harald Sitter]

Git commit 7738842943eb642c93b58e5b49484e0a8e7adfca by Harald Sitter.
Committed on 15/06/2021 at 11:35.
Pushed by sitter into branch 'Neon/release-lts'.

refine docs of displaymanager a tad

in particular with regards to the fact that desktopFile may be changed
from the outside to influence the session output

M  +7    -7    desktop/calamares/desktop/modules/displaymanager.conf

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

diff --git a/desktop/calamares/desktop/modules/displaymanager.conf b/desktop/calamares/desktop/modules/displaymanager.conf
index 47d6b19..23f4a2f 100644
--- a/desktop/calamares/desktop/modules/displaymanager.conf
+++ b/desktop/calamares/desktop/modules/displaymanager.conf
@@ -1,5 +1,5 @@
 # SPDX-License-Identifier: GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
-# SPDX-FileCopyrightText: 2018-2019 Harald Sitter <sitter at kde.org>
+# SPDX-FileCopyrightText: 2018-2021 Harald Sitter <sitter at kde.org>
 #
 # Configure one or more display managers (e.g. SDDM)
 # with a "best effort" approach.
@@ -7,7 +7,8 @@
 displaymanagers:
   - sddm
 
-#Enable the following settings to force a desktop environment in your displaymanager configuration file:
+# Force plasma as default session. calamares doesn't necessarily do a good job at picking
+# a "smart" default. Whatever smart means anyway.
 defaultDesktopEnvironment:
     # executable this is entirely pointless for sddm specifically, and in general
     # counterproductive https://github.com/calamares/calamares/issues/1248
@@ -15,13 +16,12 @@ defaultDesktopEnvironment:
     # compatibility. Ideally of course the issue should get solved and we'd
     # be able to rely on TryExec being checked by calamares.
     executable: "/bin/true"
+    # NB: this may be changed by our casper script on the live ISO.
+    #   Depending on the neon edition we may opt to use wayland instead.
     desktopFile: "plasma"
 
-#If true, try to ensure that the user, group, /var directory etc. for the
-#display manager are set up correctly. This is normally done by the distribution
-#packages, and best left to them. Therefore, it is disabled by default.
+# Only for distros where the sddm package isn't self sufficient.
 basicSetup: false
 
-#If true, setup autologin for openSUSE. This only makes sense on openSUSE
-#derivatives or other systems where /etc/sysconfig/displaymanager exists.
+# Only relevant on suse.
 sysconfigSetup: false