summary refs log tree commit diff
path: root/nixos/modules
diff options
context:
space:
mode:
authorEelco Dolstra <eelco.dolstra@logicblox.com>2013-10-23 16:59:33 +0200
committerEelco Dolstra <eelco.dolstra@logicblox.com>2013-10-23 20:08:21 +0200
commit29014a47fb9302e8b86d4cd6698298a50e8f3b25 (patch)
tree9697d2f00fb04958f83937007a3c2b8428931e2b /nixos/modules
parente29b51bfb1eefe2f8d2dcac4fba8ea734115804c (diff)
downloadnixlib-29014a47fb9302e8b86d4cd6698298a50e8f3b25.tar
nixlib-29014a47fb9302e8b86d4cd6698298a50e8f3b25.tar.gz
nixlib-29014a47fb9302e8b86d4cd6698298a50e8f3b25.tar.bz2
nixlib-29014a47fb9302e8b86d4cd6698298a50e8f3b25.tar.lz
nixlib-29014a47fb9302e8b86d4cd6698298a50e8f3b25.tar.xz
nixlib-29014a47fb9302e8b86d4cd6698298a50e8f3b25.tar.zst
nixlib-29014a47fb9302e8b86d4cd6698298a50e8f3b25.zip
Allow options to be marked as "internal"
This means they're not for end users.  Currently they're filtered from
the manual, but we could include them in a separate section.
Diffstat (limited to 'nixos/modules')
-rw-r--r--nixos/modules/config/system-path.nix1
-rw-r--r--nixos/modules/misc/assertions.nix1
-rw-r--r--nixos/modules/misc/version.nix3
-rw-r--r--nixos/modules/system/activation/top-level.nix5
4 files changed, 9 insertions, 1 deletions
diff --git a/nixos/modules/config/system-path.nix b/nixos/modules/config/system-path.nix
index e640592a97eb..0610ad54da34 100644
--- a/nixos/modules/config/system-path.nix
+++ b/nixos/modules/config/system-path.nix
@@ -85,6 +85,7 @@ in
     system = {
 
       path = mkOption {
+        internal = true;
         description = ''
           The packages you want in the boot environment.
         '';
diff --git a/nixos/modules/misc/assertions.nix b/nixos/modules/misc/assertions.nix
index 9cd58550adc9..7ded9785bc10 100644
--- a/nixos/modules/misc/assertions.nix
+++ b/nixos/modules/misc/assertions.nix
@@ -13,6 +13,7 @@ in
   options = {
 
     assertions = mkOption {
+      internal = true;
       default = [];
       example = [ { assertion = false; message = "you can't enable this for that reason"; } ];
       merge = pkgs.lib.mergeListOption;
diff --git a/nixos/modules/misc/version.nix b/nixos/modules/misc/version.nix
index 1b519d3e6eef..14437228c746 100644
--- a/nixos/modules/misc/version.nix
+++ b/nixos/modules/misc/version.nix
@@ -7,16 +7,19 @@ with pkgs.lib;
   options = {
 
     system.nixosVersion = mkOption {
+      internal = true;
       type = types.uniq types.string;
       description = "NixOS version.";
     };
 
     system.nixosVersionSuffix = mkOption {
+      internal = true;
       type = types.uniq types.string;
       description = "NixOS version suffix.";
     };
 
     system.nixosCodeName = mkOption {
+      internal = true;
       type = types.uniq types.string;
       description = "NixOS release code name.";
     };
diff --git a/nixos/modules/system/activation/top-level.nix b/nixos/modules/system/activation/top-level.nix
index 32157e419856..a04914bedaf7 100644
--- a/nixos/modules/system/activation/top-level.nix
+++ b/nixos/modules/system/activation/top-level.nix
@@ -122,6 +122,7 @@ in
   options = {
 
     system.build = mkOption {
+      internal = true;
       default = {};
       description = ''
         Attribute set of derivations used to setup the system.
@@ -144,6 +145,7 @@ in
     };
 
     system.boot.loader.id = mkOption {
+      internal = true;
       default = "";
       description = ''
         Id string of the used bootloader.
@@ -151,6 +153,7 @@ in
     };
 
     system.boot.loader.kernelFile = mkOption {
+      internal = true;
       default = pkgs.stdenv.platform.kernelTarget;
       type = types.uniq types.string;
       description = ''
@@ -169,8 +172,8 @@ in
     };
 
     system.extraSystemBuilderCmds = mkOption {
-      default = "";
       internal = true;
+      default = "";
       merge = concatStringsSep "\n";
       description = ''
         This code will be added to the builder creating the system store path.