2e751c0772
the conversion procedure is simple: - find all things that look like options, ie calls to either `mkOption` or `lib.mkOption` that take an attrset. remember the attrset as the option - for all options, find a `description` attribute who's value is not a call to `mdDoc` or `lib.mdDoc` - textually convert the entire value of the attribute to MD with a few simple regexes (the set from mdize-module.sh) - if the change produced a change in the manual output, discard - if the change kept the manual unchanged, add some text to the description to make sure we've actually found an option. if the manual changes this time, keep the converted description this procedure converts 80% of nixos options to markdown. around 2000 options remain to be inspected, but most of those fail the "does not change the manual output check": currently the MD conversion process does not faithfully convert docbook tags like <code> and <package>, so any option using such tags will not be converted at all.
189 lines
5.4 KiB
Nix
189 lines
5.4 KiB
Nix
# This module defines the packages that appear in
|
|
# /run/current-system/sw.
|
|
|
|
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
|
|
requiredPackages = map (pkg: setPrio ((pkg.meta.priority or 5) + 3) pkg)
|
|
[ pkgs.acl
|
|
pkgs.attr
|
|
pkgs.bashInteractive # bash with ncurses support
|
|
pkgs.bzip2
|
|
pkgs.coreutils-full
|
|
pkgs.cpio
|
|
pkgs.curl
|
|
pkgs.diffutils
|
|
pkgs.findutils
|
|
pkgs.gawk
|
|
pkgs.stdenv.cc.libc
|
|
pkgs.getent
|
|
pkgs.getconf
|
|
pkgs.gnugrep
|
|
pkgs.gnupatch
|
|
pkgs.gnused
|
|
pkgs.gnutar
|
|
pkgs.gzip
|
|
pkgs.xz
|
|
pkgs.less
|
|
pkgs.libcap
|
|
pkgs.ncurses
|
|
pkgs.netcat
|
|
config.programs.ssh.package
|
|
pkgs.mkpasswd
|
|
pkgs.procps
|
|
pkgs.su
|
|
pkgs.time
|
|
pkgs.util-linux
|
|
pkgs.which
|
|
pkgs.zstd
|
|
];
|
|
|
|
defaultPackageNames =
|
|
[ "nano"
|
|
"perl"
|
|
"rsync"
|
|
"strace"
|
|
];
|
|
defaultPackages =
|
|
map
|
|
(n: let pkg = pkgs.${n}; in setPrio ((pkg.meta.priority or 5) + 3) pkg)
|
|
defaultPackageNames;
|
|
defaultPackagesText = "[ ${concatMapStringsSep " " (n: "pkgs.${n}") defaultPackageNames } ]";
|
|
|
|
in
|
|
|
|
{
|
|
options = {
|
|
|
|
environment = {
|
|
|
|
systemPackages = mkOption {
|
|
type = types.listOf types.package;
|
|
default = [];
|
|
example = literalExpression "[ pkgs.firefox pkgs.thunderbird ]";
|
|
description = lib.mdDoc ''
|
|
The set of packages that appear in
|
|
/run/current-system/sw. These packages are
|
|
automatically available to all users, and are
|
|
automatically updated every time you rebuild the system
|
|
configuration. (The latter is the main difference with
|
|
installing them in the default profile,
|
|
{file}`/nix/var/nix/profiles/default`.
|
|
'';
|
|
};
|
|
|
|
defaultPackages = mkOption {
|
|
type = types.listOf types.package;
|
|
default = defaultPackages;
|
|
defaultText = literalDocBook ''
|
|
these packages, with their <literal>meta.priority</literal> numerically increased
|
|
(thus lowering their installation priority):
|
|
<programlisting>${defaultPackagesText}</programlisting>
|
|
'';
|
|
example = [];
|
|
description = ''
|
|
Set of default packages that aren't strictly necessary
|
|
for a running system, entries can be removed for a more
|
|
minimal NixOS installation.
|
|
|
|
Note: If <package>pkgs.nano</package> is removed from this list,
|
|
make sure another editor is installed and the
|
|
<literal>EDITOR</literal> environment variable is set to it.
|
|
Environment variables can be set using
|
|
<option>environment.variables</option>.
|
|
|
|
Like with systemPackages, packages are installed to
|
|
<filename>/run/current-system/sw</filename>. They are
|
|
automatically available to all users, and are
|
|
automatically updated every time you rebuild the system
|
|
configuration.
|
|
'';
|
|
};
|
|
|
|
pathsToLink = mkOption {
|
|
type = types.listOf types.str;
|
|
# Note: We need `/lib' to be among `pathsToLink' for NSS modules
|
|
# to work.
|
|
default = [];
|
|
example = ["/"];
|
|
description = lib.mdDoc "List of directories to be symlinked in {file}`/run/current-system/sw`.";
|
|
};
|
|
|
|
extraOutputsToInstall = mkOption {
|
|
type = types.listOf types.str;
|
|
default = [ ];
|
|
example = [ "doc" "info" "devdoc" ];
|
|
description = lib.mdDoc "List of additional package outputs to be symlinked into {file}`/run/current-system/sw`.";
|
|
};
|
|
|
|
extraSetup = mkOption {
|
|
type = types.lines;
|
|
default = "";
|
|
description = lib.mdDoc "Shell fragments to be run after the system environment has been created. This should only be used for things that need to modify the internals of the environment, e.g. generating MIME caches. The environment being built can be accessed at $out.";
|
|
};
|
|
|
|
};
|
|
|
|
system = {
|
|
|
|
path = mkOption {
|
|
internal = true;
|
|
description = ''
|
|
The packages you want in the boot environment.
|
|
'';
|
|
};
|
|
|
|
};
|
|
|
|
};
|
|
|
|
config = {
|
|
|
|
environment.systemPackages = requiredPackages ++ config.environment.defaultPackages;
|
|
|
|
environment.pathsToLink =
|
|
[ "/bin"
|
|
"/etc/xdg"
|
|
"/etc/gtk-2.0"
|
|
"/etc/gtk-3.0"
|
|
"/lib" # FIXME: remove and update debug-info.nix
|
|
"/sbin"
|
|
"/share/emacs"
|
|
"/share/hunspell"
|
|
"/share/nano"
|
|
"/share/org"
|
|
"/share/themes"
|
|
"/share/vim-plugins"
|
|
"/share/vulkan"
|
|
"/share/kservices5"
|
|
"/share/kservicetypes5"
|
|
"/share/kxmlgui5"
|
|
"/share/systemd"
|
|
"/share/thumbnailers"
|
|
];
|
|
|
|
system.path = pkgs.buildEnv {
|
|
name = "system-path";
|
|
paths = config.environment.systemPackages;
|
|
inherit (config.environment) pathsToLink extraOutputsToInstall;
|
|
ignoreCollisions = true;
|
|
# !!! Hacky, should modularise.
|
|
# outputs TODO: note that the tools will often not be linked by default
|
|
postBuild =
|
|
''
|
|
# Remove wrapped binaries, they shouldn't be accessible via PATH.
|
|
find $out/bin -maxdepth 1 -name ".*-wrapped" -type l -delete
|
|
|
|
if [ -x $out/bin/glib-compile-schemas -a -w $out/share/glib-2.0/schemas ]; then
|
|
$out/bin/glib-compile-schemas $out/share/glib-2.0/schemas
|
|
fi
|
|
|
|
${config.environment.extraSetup}
|
|
'';
|
|
};
|
|
|
|
};
|
|
}
|