From 52f09f7f462c36d559b1bd536bc1f140f0620365 Mon Sep 17 00:00:00 2001
From: Adriaan de Groot <groot@kde.org>
Date: Tue, 26 Jun 2018 05:47:23 -0400
Subject: [PATCH] [modules] Minor documentation work on modules a-g

---
 src/modules/bootloader/bootloader.conf         | 2 ++
 src/modules/displaymanager/displaymanager.conf | 2 ++
 src/modules/dummycpp/dummycpp.conf             | 5 ++++-
 src/modules/dummypython/dummypython.conf       | 5 ++++-
 src/modules/dummypythonqt/dummypythonqt.conf   | 3 +++
 src/modules/grubcfg/grubcfg.conf               | 1 +
 6 files changed, 16 insertions(+), 2 deletions(-)

diff --git a/src/modules/bootloader/bootloader.conf b/src/modules/bootloader/bootloader.conf
index ee8680f72..808a5e6d0 100644
--- a/src/modules/bootloader/bootloader.conf
+++ b/src/modules/bootloader/bootloader.conf
@@ -12,8 +12,10 @@ kernel: "/vmlinuz-linux"
 img: "/initramfs-linux.img"
 fallback: "/initramfs-linux-fallback.img"
 timeout: "10"
+
 # Optionally set the menu entry name and kernel name to use in systemd-boot.
 # If not specified here, these settings will be taken from branding.desc.
+#
 # bootloaderEntryName: "Generic GNU/Linux"
 # kernelLine: ", with Stable-Kernel"
 # fallbackKernelLine:  ", with Stable-Kernel (fallback initramfs)"
diff --git a/src/modules/displaymanager/displaymanager.conf b/src/modules/displaymanager/displaymanager.conf
index 1c30ed637..8f8e9c704 100644
--- a/src/modules/displaymanager/displaymanager.conf
+++ b/src/modules/displaymanager/displaymanager.conf
@@ -1,3 +1,5 @@
+# Configure one or more display managers (e.g. SDDM)
+# with a "best effort" approach.
 ---
 #The DM module attempts to set up all the DMs found in this list, in that precise order.
 #It also sets up autologin, if the feature is enabled in globalstorage.
diff --git a/src/modules/dummycpp/dummycpp.conf b/src/modules/dummycpp/dummycpp.conf
index c90b6f3b9..1f2e1daee 100644
--- a/src/modules/dummycpp/dummycpp.conf
+++ b/src/modules/dummycpp/dummycpp.conf
@@ -1,3 +1,6 @@
+# This is a dummy (example) module for C++ Jobs.
+#
+# The code is the documentation for the configuration file.
 ---
 syntax: "YAML map of anything"
 example:
@@ -15,4 +18,4 @@ a_list_of_maps:
         - "another element"
     - name: "another item"
       contents:
-        - "not much"
\ No newline at end of file
+        - "not much"
diff --git a/src/modules/dummypython/dummypython.conf b/src/modules/dummypython/dummypython.conf
index fc985089a..c700120e7 100644
--- a/src/modules/dummypython/dummypython.conf
+++ b/src/modules/dummypython/dummypython.conf
@@ -1,3 +1,6 @@
+# This is a dummy (example) module for a Python Job Module.
+#
+# The code is the documentation for the configuration file.
 ---
 syntax: "YAML map of anything"
 example:
@@ -15,4 +18,4 @@ a_list_of_maps:
         - "another element"
     - name: "another item"
       contents:
-        - "not much"
\ No newline at end of file
+        - "not much"
diff --git a/src/modules/dummypythonqt/dummypythonqt.conf b/src/modules/dummypythonqt/dummypythonqt.conf
index f60e778e1..5bc64abfa 100644
--- a/src/modules/dummypythonqt/dummypythonqt.conf
+++ b/src/modules/dummypythonqt/dummypythonqt.conf
@@ -1,3 +1,6 @@
+# This is a dummy (example) module for PythonQt.
+#
+# The code is the documentation for the configuration file.
 ---
 syntax: "YAML map of anything"
 example:
diff --git a/src/modules/grubcfg/grubcfg.conf b/src/modules/grubcfg/grubcfg.conf
index 608c9b2b4..18951a8a6 100644
--- a/src/modules/grubcfg/grubcfg.conf
+++ b/src/modules/grubcfg/grubcfg.conf
@@ -2,6 +2,7 @@
 # If set to true, always creates /etc/default/grub from scratch even if the file
 # already existed. If set to false, edits the existing file instead.
 overwrite: false
+
 # Default entries to write to /etc/default/grub if it does not exist yet or if
 # we are overwriting it. Note that in addition, GRUB_CMDLINE_LINUX_DEFAULT and
 # GRUB_DISTRIBUTOR will always be written, with automatically detected values.