From a12a8f7977ee5fbac6e0b409f552c92455043e52 Mon Sep 17 00:00:00 2001
From: Gregory Oakes <gregory.oakes@outlook.com>
Date: Wed, 25 Dec 2019 10:16:27 -0800
Subject: [PATCH] random-background: add `bgSupport` documentation

On NixOS it is necessary to set `bgSupport = true` when creating a
Home Manager desktop manager session. Otherwise NixOS will add code
that sets the background, overriding the effort made by the
`random-background` module.

Fixes #955
Pull request #956
---
 modules/services/random-background.nix | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/modules/services/random-background.nix b/modules/services/random-background.nix
index cbec97ae7..885574aff 100644
--- a/modules/services/random-background.nix
+++ b/modules/services/random-background.nix
@@ -22,7 +22,17 @@ in
 
   options = {
     services.random-background = {
-      enable = mkEnableOption "random desktop background";
+      enable = mkEnableOption "" // {
+        description = ''
+          Whether to enable random desktop background.
+          </para><para>
+          Note, if you are using NixOS and have set up a custom
+          desktop manager session for Home Manager, then the session
+          configuration must have the <option>bgSupport</option>
+          option set to <literal>true</literal> or the background
+          image set by this module may be overwritten.
+        '';
+      };
 
       imageDirectory = mkOption {
         type = types.str;