Document the shared module and options

barrucadu · Oct 15, 2023 · 6bdd1ef · 6bdd1ef
1 parent 539a512
commit 6bdd1ef
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/shared/default.nix b/shared/default.nix
@@ -1,3 +1,4 @@
+# Common configuration enabled on all hosts.
 { config, lib, pkgs, flakeInputs, ... }:
 
 with lib;

diff --git a/shared/options.nix b/shared/options.nix
@@ -4,6 +4,12 @@ with lib;
 
 {
   options.nixfiles.firewall = {
-    ipBlocklistFile = mkOption { type = types.nullOr types.str; default = null; };
+    ipBlocklistFile = mkOption {
+      type = types.nullOr types.str;
+      default = null;
+      description = mdDoc ''
+        File containing IPs to block.
+      '';
+    };
   };
 }