e65131e69c
This process was automated by [my fork of `nix-doc-munge`]; thanks
to @pennae for writing this tool! It automatically checks that the
resulting documentation doesn't change, although my fork loosens
this a little to ignore some irrelevant whitespace and typographical
differences.
As of this commit there is no DocBook remaining in the options
documentation.
You can play along at home if you want to reproduce this commit:
$ NIX_PATH=nixpkgs=flake:nixpkgs/c1bca7fe84c646cfd4ebf3482c0e6317a0b13f22 \
nix shell nixpkgs#coreutils \
-c find . -name '*.nix' \
-exec nix run github:emilazy/nix-doc-munge/0a7190f600027bf7baf6cb7139e4d69ac2f51062 \
{} +
[my fork of `nix-doc-munge`]: https://github.com/emilazy/nix-doc-munge
117 lines
3.8 KiB
Nix
117 lines
3.8 KiB
Nix
{ options, config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
cfg = config.system;
|
|
|
|
defaultStateVersion = options.system.stateVersion.default;
|
|
|
|
parseGit = path:
|
|
if pathExists "${path}/.git" then rec {
|
|
rev = commitIdFromGitRepo "${path}/.git";
|
|
shortRev = substring 0 7 rev;
|
|
}
|
|
else if pathExists "${path}/.git-revision" then rec {
|
|
rev = fileContents "${path}/.git-revision";
|
|
shortRev = substring 0 7 rev;
|
|
}
|
|
else {
|
|
shortRev = "0000000";
|
|
};
|
|
|
|
darwin = parseGit (toString ../..);
|
|
nixpkgs = parseGit (toString pkgs.path);
|
|
|
|
releaseFile = "${toString pkgs.path}/.version";
|
|
suffixFile = "${toString pkgs.path}/.version-suffix";
|
|
|
|
nixpkgsSuffix = if pathExists suffixFile then fileContents suffixFile
|
|
else ".git." + nixpkgs.shortRev;
|
|
in
|
|
|
|
{
|
|
options = {
|
|
system.stateVersion = mkOption {
|
|
type = types.int;
|
|
default = 4;
|
|
description = lib.mdDoc ''
|
|
Every once in a while, a new NixOS release may change
|
|
configuration defaults in a way incompatible with stateful
|
|
data. For instance, if the default version of PostgreSQL
|
|
changes, the new version will probably be unable to read your
|
|
existing databases. To prevent such breakage, you can set the
|
|
value of this option to the NixOS release with which you want
|
|
to be compatible. The effect is that NixOS will option
|
|
defaults corresponding to the specified release (such as using
|
|
an older version of PostgreSQL).
|
|
'';
|
|
};
|
|
|
|
system.darwinLabel = mkOption {
|
|
type = types.str;
|
|
description = lib.mdDoc "Label to be used in the names of generated outputs.";
|
|
};
|
|
|
|
system.darwinVersion = mkOption {
|
|
internal = true;
|
|
type = types.str;
|
|
description = lib.mdDoc "The full darwin version (e.g. `darwin4.master`).";
|
|
};
|
|
|
|
system.darwinVersionSuffix = mkOption {
|
|
internal = true;
|
|
type = types.str;
|
|
description = lib.mdDoc "The short darwin version suffix (e.g. `.2abdb5a`).";
|
|
};
|
|
|
|
system.darwinRevision = mkOption {
|
|
internal = true;
|
|
type = types.str;
|
|
default = "master";
|
|
description = lib.mdDoc "The darwin git revision from which this configuration was built.";
|
|
};
|
|
|
|
system.nixpkgsRelease = mkOption {
|
|
readOnly = true;
|
|
type = types.str;
|
|
description = lib.mdDoc "The nixpkgs release (e.g. `16.03`).";
|
|
};
|
|
|
|
system.nixpkgsVersion = mkOption {
|
|
internal = true;
|
|
type = types.str;
|
|
description = lib.mdDoc "The full nixpkgs version (e.g. `16.03.1160.f2d4ee1`).";
|
|
};
|
|
|
|
system.nixpkgsVersionSuffix = mkOption {
|
|
internal = true;
|
|
type = types.str;
|
|
description = lib.mdDoc "The short nixpkgs version suffix (e.g. `.1160.f2d4ee1`).";
|
|
};
|
|
|
|
system.nixpkgsRevision = mkOption {
|
|
internal = true;
|
|
type = types.str;
|
|
description = lib.mdDoc "The nixpkgs git revision from which this configuration was built.";
|
|
};
|
|
};
|
|
|
|
config = {
|
|
|
|
# These defaults are set here rather than up there so that
|
|
# changing them would not rebuild the manual
|
|
system.darwinLabel = mkDefault "${cfg.nixpkgsVersion}+${cfg.darwinVersion}";
|
|
system.darwinVersion = mkDefault "darwin${toString cfg.stateVersion}${cfg.darwinVersionSuffix}";
|
|
system.darwinVersionSuffix = mkDefault ".${darwin.shortRev}";
|
|
system.darwinRevision = mkIf (darwin ? rev) (mkDefault darwin.rev);
|
|
|
|
system.nixpkgsVersion = mkDefault "${cfg.nixpkgsRelease}${cfg.nixpkgsVersionSuffix}";
|
|
system.nixpkgsRelease = mkDefault (fileContents releaseFile);
|
|
system.nixpkgsVersionSuffix = mkDefault nixpkgsSuffix;
|
|
system.nixpkgsRevision = mkIf (nixpkgs ? rev) (mkDefault nixpkgs.rev);
|
|
|
|
assertions = [ { assertion = cfg.stateVersion <= defaultStateVersion; message = "system.stateVersion = ${toString cfg.stateVersion}; is not a valid value"; } ];
|
|
|
|
};
|
|
}
|