movefasta/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-06-12 04:35:41 +03:00
Code Issues Projects Releases Packages Wiki Activity

nixos: documentation: move some code around, make docstrings more informative

Browse source
This commit is contained in:
Jan Malakhovski 2018-04-05 22:20:46 +00:00 • committed by Profpatsch
parent 2becf90c93
commit 483815a743
1 changed files with 18 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -16,7 +16,10 @@ let cfg = config.documentation; in
description = '' description = ''
Whether to install documentation of packages from Whether to install documentation of packages from
<option>environment.systemPackages</option> into the generated system path. <option>environment.systemPackages</option> into the generated system path.
See "Multiple-output packages" chapter in the nixpkgs manual for more info.
''; '';
# which is at ../../../doc/multiple-output.xml
}; };
man.enable = mkOption { man.enable = mkOption {
@ -28,6 +31,15 @@ let cfg = config.documentation; in
''; '';
}; };
info.enable = mkOption {
type = types.bool;
default = true;
description = ''
Whether to install info pages and the <command>info</command> command.
This also includes "info" outputs.
'';
};
doc.enable = mkOption { doc.enable = mkOption {
type = types.bool; type = types.bool;
default = true; default = true;
@ -38,14 +50,6 @@ let cfg = config.documentation; in
''; '';
}; };
info.enable = mkOption {
type = types.bool;
default = true;
description = ''
Whether to install info pages and the <command>info</command> command.
This also includes "info" outputs.
'';
};
}; };
@ -59,6 +63,12 @@ let cfg = config.documentation; in
environment.extraOutputsToInstall = [ "man" ]; environment.extraOutputsToInstall = [ "man" ];
}) })
(mkIf cfg.info.enable {
environment.systemPackages = [ pkgs.texinfoInteractive ];
environment.pathsToLink = [ "/share/info" ];
environment.extraOutputsToInstall = [ "info" ];
})
(mkIf cfg.doc.enable { (mkIf cfg.doc.enable {
# TODO(@oxij): put it here and remove from profiles? # TODO(@oxij): put it here and remove from profiles?
# environment.systemPackages = [ pkgs.w3m ]; # w3m-nox? # environment.systemPackages = [ pkgs.w3m ]; # w3m-nox?
@ -66,12 +76,6 @@ let cfg = config.documentation; in
environment.extraOutputsToInstall = [ "doc" ]; environment.extraOutputsToInstall = [ "doc" ];
}) })
(mkIf cfg.info.enable {
environment.systemPackages = [ pkgs.texinfoInteractive ];
environment.pathsToLink = [ "/share/info" ];
environment.extraOutputsToInstall = [ "info" ];
})
]); ]);
} }