From 2dc019493d2885cd35a942f53a065aebf0e51424 Mon Sep 17 00:00:00 2001
From: Adriaan de Groot <groot@kde.org>
Date: Wed, 9 Aug 2017 10:59:14 -0400
Subject: [PATCH] Modules: docs for users.conf

---
 src/modules/users/users.conf | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/src/modules/users/users.conf b/src/modules/users/users.conf
index 5dfa8e947..dea0ba999 100644
--- a/src/modules/users/users.conf
+++ b/src/modules/users/users.conf
@@ -1,3 +1,15 @@
+# Configuration for the one-user-system user module.
+#
+# Besides these settings, the user module also places the following
+# keys into the globalconfig area, based on user input in the view step.
+#
+# - hostname
+# - username
+# - password (obscured)
+# - autologinUser (if enabled, set to username)
+#
+# These globalconfig keys are set when the jobs for this module
+# are created.
 ---
 defaultGroups:
     - users