movefasta/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-06-11 20:25:32 +03:00
Code Issues Projects Releases Packages Wiki Activity

nixos/doc: clean up defaults and examples

Browse source
This commit is contained in:
Naïm Favier 2021-10-03 18:06:03 +02:00
parent 330b1e08b8
commit 2ddc335e6f
No known key found for this signature in database
GPG key ID: 49B07322580B7EE2
584 changed files with 1612 additions and 1554 deletions
Download patch file Download diff file Expand all files Collapse all files

4
nixos/modules/misc/documentation.nix
View file

@ -133,7 +133,7 @@ in
extraOutputsToInstall = ["man"];
ignoreCollisions = true;
};
defaultText = "all man pages in config.environment.systemPackages";
defaultText = literalDocBook "all man pages in <option>config.environment.systemPackages</option>";
description = ''
The manual pages to generate caches for if <option>generateCaches</option>
is enabled. Must be a path to a directory with man pages under
@ -211,7 +211,7 @@ in
Which extra NixOS module paths the generated NixOS's documentation should strip
from options.
'';
example = literalExample ''
example = literalExpression ''
# e.g. with options from modules in ''${pkgs.customModules}/nix:
[ pkgs.customModules ]
'';