Merge pull request #191 from linj-fork/fix-doc

doc: fix defaultText and description
ryantm · Jul 14, 2023 · 0d8c532 · 0d8c532
2 parents db5637d + 6e8a48c
commit 0d8c532
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 7 deletions.
diff --git a/modules/age-home.nix b/modules/age-home.nix
@@ -149,9 +149,10 @@ with lib; let
       else "$XDG_RUNTIME_DIR";
   in "${baseDir}/${dir}";
 
-  userDirectoryDescription = dir: ''
-    "$XDG_RUNTIME_DIR"/${dir} on linux or "$(getconf DARWIN_USER_TEMP_DIR)"/${dir} on darwin.
-  '';
+  userDirectoryDescription = dir:
+    literalExpression ''
+      "$XDG_RUNTIME_DIR"/${dir} on linux or "$(getconf DARWIN_USER_TEMP_DIR)"/${dir} on darwin.
+    '';
 in {
   options.age = {
     package = mkPackageOption pkgs "rage" {};
@@ -170,7 +171,7 @@ in {
         "${config.home.homeDirectory}/.ssh/id_ed25519"
         "${config.home.homeDirectory}/.ssh/id_rsa"
       ];
-      defaultText = litteralExpression ''
+      defaultText = literalExpression ''
         [
           "''${config.home.homeDirectory}/.ssh/id_ed25519"
           "''${config.home.homeDirectory}/.ssh/id_rsa"

diff --git a/modules/age.nix b/modules/age.nix
@@ -133,8 +133,9 @@ with lib; let
       name = mkOption {
         type = types.str;
         default = config._module.args.name;
+        defaultText = literalExpression "config._module.args.name";
         description = ''
-          Name of the file used in ''${cfg.secretsDir}
+          Name of the file used in {option}`age.secretsDir`
         '';
       };
       file = mkOption {
@@ -146,6 +147,9 @@ with lib; let
       path = mkOption {
         type = types.str;
         default = "${cfg.secretsDir}/${config.name}";
+        defaultText = literalExpression ''
+          "''${cfg.secretsDir}/''${config.name}"
+        '';
         description = ''
           Path where the decrypted secret is installed.
         '';
@@ -167,6 +171,9 @@ with lib; let
       group = mkOption {
         type = types.str;
         default = users.${config.owner}.group or "0";
+        defaultText = literalExpression ''
+          users.''${config.owner}.group or "0"
+        '';
         description = ''
           Group of the decrypted secret.
         '';
@@ -183,6 +190,9 @@ in {
     ageBin = mkOption {
       type = types.str;
       default = "${pkgs.rage}/bin/rage";
+      defaultText = literalExpression ''
+        "''${pkgs.rage}/bin/rage"
+      '';
       description = ''
         The age executable to use.
       '';
@@ -210,9 +220,8 @@ in {
           && (builtins.match ".+/" s) == null) # without trailing slash
         // {description = "${types.str.description} (with check: non-empty without trailing slash)";};
       default = "/run/agenix.d";
-      defaultText = "/run/agenix.d";
       description = ''
-        Where secrets are created before they are symlinked to ''${cfg.secretsDir}
+        Where secrets are created before they are symlinked to {option}`age.secretsDir`
       '';
     };
     identityPaths = mkOption {
@@ -226,6 +235,16 @@ in {
           "/etc/ssh/ssh_host_rsa_key"
         ]
         else [];
+      defaultText = literalExpression ''
+        if (config.services.openssh.enable or false)
+        then map (e: e.path) (lib.filter (e: e.type == "rsa" || e.type == "ed25519") config.services.openssh.hostKeys)
+        else if isDarwin
+        then [
+          "/etc/ssh/ssh_host_ed25519_key"
+          "/etc/ssh/ssh_host_rsa_key"
+        ]
+        else [];
+      '';
       description = ''
         Path to SSH keys to be used as identities in age decryption.
       '';