From 642bfe3b1e9175639ae43e9051933ca595d5afbd Mon Sep 17 00:00:00 2001
From: Christopher James Hayward <chris@chrishayward.xyz>
Date: Thu, 10 Mar 2022 15:30:04 -0500
Subject: [PATCH] Add home-manager file warning

---
 README.org        | 12 ++++++++++++
 modules/emacs.nix |  1 +
 modules/git.nix   |  1 +
 modules/gpg.nix   |  1 +
 modules/gtk.nix   |  1 +
 modules/vim.nix   |  1 +
 6 files changed, 17 insertions(+)

diff --git a/README.org b/README.org
index aebe30c..21321cd 100644
--- a/README.org
+++ b/README.org
@@ -828,6 +828,13 @@ inputs.home-manager.nixosModules.home-manager {
 }
 #+END_SRC
 
+Certain modules have to be included within home manager or they will not function correctly.
+
+#+NAME: home-manager-warning
+#+BEGIN_SRC text
+This module MUST be included within home manager
+#+END_SRC
+
 *** Git
 
 #+NAME: module-git
@@ -839,6 +846,7 @@ inputs.home-manager.nixosModules.home-manager {
 
 #+BEGIN_SRC nix :noweb yes :tangle modules/git.nix
 # <<file-warning>>
+# <<home-manager-warning>>
 { pkgs, ... }:
 
 let
@@ -879,6 +887,7 @@ in {
 
 #+BEGIN_SRC nix :noweb yes :tangle modules/gpg.nix
 # <<file-warning>>
+# <<home-manager-warning>>
 { pkgs, ... }:
 
 {
@@ -907,6 +916,7 @@ in {
 
 #+BEGIN_SRC nix :noweb yes :tangle modules/vim.nix
 # <<file-warning>>
+# <<home-manager-warning>>
 { pkgs, ... }:
 
 {
@@ -942,6 +952,7 @@ in {
 
 #+BEGIN_SRC nix :noweb yes :tangle modules/gtk.nix
 # <<file-warning>>
+# <<home-manager-warning>>
 { pkgs, ... }:
 
 {
@@ -1023,6 +1034,7 @@ in {
 
 #+BEGIN_SRC nix :noweb yes :tangle modules/emacs.nix
 # <<file-warning>>
+# <<home-manager-warning>>
 { pkgs, ... }:
 
 let
diff --git a/modules/emacs.nix b/modules/emacs.nix
index 20b0e8f..1b065d4 100644
--- a/modules/emacs.nix
+++ b/modules/emacs.nix
@@ -1,4 +1,5 @@
 # This file is controlled by /etc/dotfiles/README.org
+# This module MUST be included within home manager
 { pkgs, ... }:
 
 let
diff --git a/modules/git.nix b/modules/git.nix
index 32bf80f..5b4355b 100644
--- a/modules/git.nix
+++ b/modules/git.nix
@@ -1,4 +1,5 @@
 # This file is controlled by /etc/dotfiles/README.org
+# This module MUST be included within home manager
 { pkgs, ... }:
 
 let
diff --git a/modules/gpg.nix b/modules/gpg.nix
index 2eb186a..1b72008 100644
--- a/modules/gpg.nix
+++ b/modules/gpg.nix
@@ -1,4 +1,5 @@
 # This file is controlled by /etc/dotfiles/README.org
+# This module MUST be included within home manager
 { pkgs, ... }:
 
 {
diff --git a/modules/gtk.nix b/modules/gtk.nix
index 09e55a0..8aef6bf 100644
--- a/modules/gtk.nix
+++ b/modules/gtk.nix
@@ -1,4 +1,5 @@
 # This file is controlled by /etc/dotfiles/README.org
+# This module MUST be included within home manager
 { pkgs, ... }:
 
 {
diff --git a/modules/vim.nix b/modules/vim.nix
index b273fdd..df11dfa 100644
--- a/modules/vim.nix
+++ b/modules/vim.nix
@@ -1,4 +1,5 @@
 # This file is controlled by /etc/dotfiles/README.org
+# This module MUST be included within home manager
 { pkgs, ... }:
 
 {