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
68 lines
1.3 KiB
Nix
68 lines
1.3 KiB
Nix
{ lib, mkTextDerivation }:
|
|
|
|
{ config, name, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
fileName = file: last (splitString "/" file);
|
|
mkDefaultIf = cond: value: mkIf cond (mkDefault value);
|
|
|
|
drv = mkTextDerivation (fileName name) config.text;
|
|
in
|
|
|
|
{
|
|
options = {
|
|
enable = mkOption {
|
|
type = types.bool;
|
|
default = true;
|
|
description = lib.mdDoc ''
|
|
Whether this file should be generated.
|
|
This option allows specific files to be disabled.
|
|
'';
|
|
};
|
|
|
|
text = mkOption {
|
|
type = types.lines;
|
|
default = "";
|
|
description = lib.mdDoc ''
|
|
Text of the file.
|
|
'';
|
|
};
|
|
|
|
target = mkOption {
|
|
type = types.str;
|
|
default = name;
|
|
description = lib.mdDoc ''
|
|
Name of symlink. Defaults to the attribute name.
|
|
'';
|
|
};
|
|
|
|
source = mkOption {
|
|
type = types.path;
|
|
description = lib.mdDoc ''
|
|
Path of the source file.
|
|
'';
|
|
};
|
|
|
|
copy = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc ''
|
|
Whether this file should be copied instead of symlinking.
|
|
'';
|
|
};
|
|
|
|
knownSha256Hashes = mkOption {
|
|
internal = true;
|
|
type = types.listOf types.str;
|
|
default = [];
|
|
};
|
|
};
|
|
|
|
config = {
|
|
|
|
source = mkDefault drv;
|
|
|
|
};
|
|
}
|