[users] Add new structured setting to example file

src/modules/users/users.conf

@@ -140,13 +140,25 @@ allowWeakPasswords: false
 # to be unchecked.
 allowWeakPasswordsDefault: false
 
-# Shell to be used for the regular user of the target system.
+# User settings
-# There are three possible kinds of settings:
+#
-#  - unset (i.e. commented out, the default), act as if set to /bin/bash
+# The user can enter a username, but there are some other
-#  - empty (explicit), don't pass shell information to useradd at all
+# hidden settings for the user which are configurable in Calamares.
-#    and rely on a correct configuration file in /etc/default/useradd
+#
-#  - set, non-empty, use that path as shell. No validation is done
+# Key *user* has the following sub-keys:
-#    that the shell actually exists or is executable.
+#
+# - *shell* Shell to be used for the regular user of the target system.
+#   There are three possible kinds of settings:
+#    - unset (i.e. commented out, the default), act as if set to /bin/bash
+#    - empty (explicit), don't pass shell information to useradd at all
+#      and rely on a correct configuration file in /etc/default/useradd
+#    - set, non-empty, use that path as shell. No validation is done
+#      that the shell actually exists or is executable.
+user:
+  shell: /bin/bash
+# TODO:3.3: Remove this setting
+#
+# This is the legacy setting for user.shell
 userShell: /bin/bash
 
 # Hostname settings