improve descriptions for base and busybox

This commit is contained in:
Daniel Barlow 2023-08-12 20:11:43 +01:00
parent 519de0b55c
commit f93c03c98a
2 changed files with 40 additions and 8 deletions

View file

@ -13,35 +13,66 @@ let
in { in {
imports = [ imports = [
./kernel.nix # this is a separate module for doc purposes ./kernel.nix # kernel is a separate module for doc purposes
]; ];
options = { options = {
# analogous to nixos systemPackages, but we don't symlink into
# /run/current-system, we just add the paths in /etc/profile
defaultProfile = { defaultProfile = {
packages = mkOption { packages = mkOption {
type = types.listOf types.package; type = types.listOf types.package;
description = ''
List of packages which are available in a login shell. (This
is analogous to systemPackages in NixOS, but we don't symlink into
/run/current-system, we just add the paths in /etc/profile
'';
}; };
}; };
services = mkOption { services = mkOption {
type = types.attrsOf type_service; type = types.attrsOf type_service;
}; };
filesystem = mkOption { type = types.anything; }; filesystem = mkOption {
type = types.anything;
description = ''
Skeleton filesystem, represented as nested attrset. Consult the
source code if you need to add to this
'';
# internal = true; # probably a good case to make this internal
};
rootfsType = mkOption { rootfsType = mkOption {
default = "squashfs"; default = "squashfs";
type = types.str; type = types.enum ["squashfs" "jffs2"];
}; };
boot = { boot = {
commandLine = mkOption { commandLine = mkOption {
type = types.listOf types.nonEmptyStr; type = types.listOf types.nonEmptyStr;
default = []; default = [];
description = "Kernel command line";
}; };
tftp = { tftp = {
loadAddress = mkOption { type = types.str; }; loadAddress = mkOption {
type = types.str;
description = ''
RAM address at which to load data when transferring via
TFTP. This is not the address of the flash storage,
nor the kernel load address: it should be set to some part
of RAM that's not used for anything else and suitable for
temporary storage.
'';
};
# These names match the uboot environment variables. I reserve # These names match the uboot environment variables. I reserve
# the right to change them if I think of better ones. # the right to change them if I think of better ones.
ipaddr = mkOption { type = types.str; }; ipaddr = mkOption {
serverip = mkOption { type = types.str; }; type = types.str;
description = ''
Our IP address to use when creating scripts to
boot or flash from U-Boot. Not relevant in normal operation
'';
};
serverip = mkOption {
type = types.str;
description = ''
IP address of the TFTP server. Not relevant in normal operation
'';
};
}; };
}; };
}; };

View file

@ -65,6 +65,7 @@ in {
description = "Other busybox config flags that do not map directly to applet names (often prefixed FEATURE_)"; description = "Other busybox config flags that do not map directly to applet names (often prefixed FEATURE_)";
type = types.attrsOf types.nonEmptyStr; type = types.attrsOf types.nonEmptyStr;
default = { }; default = { };
example = { FEATURE_DD_IBS_OBS = "y"; };
}; };
}; };
}; };