diff --git a/lib/options.nix b/lib/options.nix index a91115287e4..20ffc61c1ad 100644 --- a/lib/options.nix +++ b/lib/options.nix @@ -275,6 +275,7 @@ rec { description = opt.description or (throw "Option ${opt.name}: No description."); declarations = map (x: toString x.source) opt.declarations; #definitions = map (x: toString x.source) opt.definitions; + internal = opt.internal or false; } // optionalAttrs (opt ? example) { example = scrubOptionValue opt.example; } // optionalAttrs (opt ? default) { default = scrubOptionValue opt.default; } diff --git a/nixos/doc/manual/default.nix b/nixos/doc/manual/default.nix index c887e7f0317..02732949b7c 100644 --- a/nixos/doc/manual/default.nix +++ b/nixos/doc/manual/default.nix @@ -7,8 +7,9 @@ with pkgs.lib; let - optionsXML = builtins.toFile "options.xml" (builtins.unsafeDiscardStringContext - (builtins.toXML (optionAttrSetToDocList options))); + options' = filter (x: !x.internal) (optionAttrSetToDocList options); + + optionsXML = builtins.toFile "options.xml" (builtins.unsafeDiscardStringContext (builtins.toXML options')); optionsDocBook = pkgs.runCommand "options-db.xml" {} '' ${pkgs.libxslt}/bin/xsltproc \ diff --git a/nixos/modules/config/system-path.nix b/nixos/modules/config/system-path.nix index e640592a97e..0610ad54da3 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 9cd58550adc..7ded9785bc1 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 1b519d3e6ee..14437228c74 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 32157e41985..a04914bedaf 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.