From 8255bc3fc129b46fec577b3501d061b6056fa2ce Mon Sep 17 00:00:00 2001
From: Adriaan de Groot <groot@kde.org>
Date: Mon, 8 Jun 2020 07:06:03 -0400
Subject: [PATCH] [welcome] Sanitize example configurations

- remove all duplicated documentation from ; it's the same as
  `welcome.conf` in all respects except for *qmlSearch*.
---
 src/modules/welcome/welcome.conf   |  8 ++++
 src/modules/welcomeq/welcomeq.conf | 66 ++++--------------------------
 2 files changed, 17 insertions(+), 57 deletions(-)

diff --git a/src/modules/welcome/welcome.conf b/src/modules/welcome/welcome.conf
index d8da60d19..45cb654a2 100644
--- a/src/modules/welcome/welcome.conf
+++ b/src/modules/welcome/welcome.conf
@@ -67,6 +67,14 @@ requirements:
 # Also, note the analogous feature in `src/modules/locale/locale.conf`,
 # which is where you will find complete documentation.
 #
+# For testing, the *style* may be set to `fixed`, any URL that
+# returns data (e.g. `http://example.com`) and then *selector*
+# sets the data that is actually returned (e.g. "DE" to simulate
+# the machine being in Germany).
+#
+# NOTE: the *selector* must pick the country code from the GeoIP
+#       data. Timezone, city, or other data will not be recognized.
+#
 geoip:
     style:    "none"
     url:      "https://geoip.kde.org/v1/ubiquity"  # extended XML format
diff --git a/src/modules/welcomeq/welcomeq.conf b/src/modules/welcomeq/welcomeq.conf
index 6c2cf9557..6c131742e 100644
--- a/src/modules/welcomeq/welcomeq.conf
+++ b/src/modules/welcomeq/welcomeq.conf
@@ -1,52 +1,23 @@
-# Configuration for the welcome module. The welcome page
-# displays some information from the branding file.
-# Which parts it displays can be configured through
-# the show* variables.
+# Configuration for the welcomeq module.
 #
-# In addition to displaying the welcome page, this module
-# can check requirements for installation.
+# The configuration for welcomeq is exactly the same
+# as the welcome module, with the one exception of
+# *qmlSearch* which governs QML loading.
+#
+# No documentation is given here: look in the welcome module.
 ---
-# Setting for QML loading
+# Setting for QML loading: use QRC, branding, or both sources of files
 qmlSearch: both
-# Display settings for various buttons on the welcome page.
-# The URLs themselves come from branding.desc is the setting
-# here is "true". If the setting is false, the button is hidden.
-# The setting can also be a full URL which will then be used
-# instead of the one from the branding file, or empty or not-set
-# which will hide the button.
+
+# Everythin below here is documented in `welcome.conf`
 showSupportUrl:         true
 showKnownIssuesUrl:     true
 showReleaseNotesUrl:    true
 
-# If this Url is set to something non-empty, a "donate"
-# button is added to the welcome page alongside the
-# others (see settings, above). Clicking the button opens
-# the corresponding link. (This button has no corresponding
-# branding.desc string)
-#
-# showDonateUrl:  https://kde.org/community/donations/
-
-# Requirements checking. These are general, generic, things
-# that are checked. They may not match with the actual requirements
-# imposed by other modules in the system.
 requirements:
-    # Amount of available disk, in GiB. Floating-point is allowed here.
-    # Note that this does not account for *usable* disk, so it is possible
-    # to pass this requirement, yet have no space to install to.
     requiredStorage:    5.5
-
-    # Amount of available RAM, in GiB. Floating-point is allowed here.
     requiredRam:        1.0
-
-    # To check for internet connectivity, Calamares does a HTTP GET
-    # on this URL; on success (e.g. HTTP code 200) internet is OK.
     internetCheckUrl:   http://google.com
-
-    # List conditions to check. Each listed condition will be
-    # probed in some way, and yields true or false according to
-    # the host system satisfying the condition.
-    #
-    # This sample file lists all the conditions that are known.
     check:
         - storage
         - ram
@@ -54,28 +25,9 @@ requirements:
         - internet
         - root
         - screen
-    # List conditions that **must** be satisfied (from the list
-    # of conditions, above) for installation to proceed.
-    # If any of these conditions are not met, the user cannot
-    # continue past the welcome page.
     required:
-       # - storage
         - ram
-       # - root
 
-# GeoIP checking
-#
-# This can be used to pre-select a language based on the country
-# the user is currently in. It *assumes* that there's internet
-# connectivity, though. Configuration is like in the locale module,
-# but remember to use a URL that returns full data **and** to
-# use a selector that will pick the country, not the timezone.
-#
-# To disable GeoIP checking, either comment-out the entire geoip section,
-# or set the *style* key to an unsupported format (e.g. `none`).
-# Also, note the analogous feature in `src/modules/locale/locale.conf`,
-# which is where you will find complete documentation.
-#
 geoip:
     style:    "none"
     url:      "https://geoip.kde.org/v1/ubiquity"  # extended XML format