From 212fcf4cde24f49cd5fee723e45de73cf49615a9 Mon Sep 17 00:00:00 2001
From: DavHau <hsngrmpf+github@gmail.com>
Date: Tue, 10 Oct 2023 20:04:36 +0200
Subject: [PATCH] docs: add missing descriptions for core module

---
 modules/dream2nix/core/env/default.nix          | 3 +++
 modules/dream2nix/core/eval-cache/interface.nix | 4 ++++
 modules/dream2nix/core/flags/default.nix        | 6 ++++++
 modules/dream2nix/core/lock/interface.nix       | 4 ++++
 4 files changed, 17 insertions(+)

diff --git a/modules/dream2nix/core/env/default.nix b/modules/dream2nix/core/env/default.nix
index 55a5b19f48..814c7257fe 100644
--- a/modules/dream2nix/core/env/default.nix
+++ b/modules/dream2nix/core/env/default.nix
@@ -15,6 +15,9 @@ in {
       in
         t.attrsOf (t.nullOr (t.oneOf allTypes));
       default = {};
+      description = ''
+        environment variables passed to the build environment
+      '';
     };
   };
 }
diff --git a/modules/dream2nix/core/eval-cache/interface.nix b/modules/dream2nix/core/eval-cache/interface.nix
index c0a516295f..6a1ec437f5 100644
--- a/modules/dream2nix/core/eval-cache/interface.nix
+++ b/modules/dream2nix/core/eval-cache/interface.nix
@@ -14,6 +14,10 @@ in {
       type = t.submodule {
         freeformType = t.anything;
       };
+      description = ''
+        The content of the cached fields.
+        For example if fields.pname is set to true, then content.pname will exist.
+      '';
     };
 
     invalidationFields = l.mkOption {
diff --git a/modules/dream2nix/core/flags/default.nix b/modules/dream2nix/core/flags/default.nix
index 8986b9306c..58ea7e219b 100644
--- a/modules/dream2nix/core/flags/default.nix
+++ b/modules/dream2nix/core/flags/default.nix
@@ -44,6 +44,9 @@ in {
     flagsOffered = l.mkOption {
       type = t.attrsOf t.str;
       default = {};
+      description = ''
+        declare flags that can be used to enable/disable features
+      '';
     };
 
     # The flag options generated from `flagsOffered`
@@ -52,6 +55,9 @@ in {
         options = l.mapAttrs (_: mkFlag) config.flagsOffered;
       };
       default = {};
+      description = ''
+        Enable/disable flags declared in `flagsOffered`
+      '';
     };
   };
 }
diff --git a/modules/dream2nix/core/lock/interface.nix b/modules/dream2nix/core/lock/interface.nix
index f9a5bcf0ce..d5329bb02e 100644
--- a/modules/dream2nix/core/lock/interface.nix
+++ b/modules/dream2nix/core/lock/interface.nix
@@ -17,6 +17,10 @@ in {
       type = t.submodule {
         freeformType = t.anything;
       };
+      description = ''
+        The content of the lock file.
+        All fields declared via `lock.fields` are contained pointing to their respective values.
+      '';
     };
 
     fields = l.mkOption {