mirror of
https://github.com/hercules-ci/flake-parts.git
synced 2024-12-14 11:47:31 +00:00
Remove redundant lib.mdDoc
This commit is contained in:
parent
6b87695050
commit
d8f05073ae
9 changed files with 14 additions and 14 deletions
2
lib.nix
2
lib.nix
|
@ -109,7 +109,7 @@ let
|
||||||
${name} = mkOption {
|
${name} = mkOption {
|
||||||
type = types.lazyAttrsOf option.type;
|
type = types.lazyAttrsOf option.type;
|
||||||
default = { };
|
default = { };
|
||||||
description = lib.mdDoc ''
|
description = ''
|
||||||
See {option}`perSystem.${name}` for description and examples.
|
See {option}`perSystem.${name}` for description and examples.
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
|
|
|
@ -27,13 +27,13 @@ let
|
||||||
type = mkOption {
|
type = mkOption {
|
||||||
type = lib.types.enum [ "app" ];
|
type = lib.types.enum [ "app" ];
|
||||||
default = "app";
|
default = "app";
|
||||||
description = lib.mdDoc ''
|
description = ''
|
||||||
A type tag for `apps` consumers.
|
A type tag for `apps` consumers.
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
program = mkOption {
|
program = mkOption {
|
||||||
type = programType;
|
type = programType;
|
||||||
description = lib.mdDoc ''
|
description = ''
|
||||||
A path to an executable or a derivation with `meta.mainProgram`.
|
A path to an executable or a derivation with `meta.mainProgram`.
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
|
|
|
@ -18,7 +18,7 @@ in
|
||||||
type = types.lazyAttrsOf types.unspecified;
|
type = types.lazyAttrsOf types.unspecified;
|
||||||
default = { };
|
default = { };
|
||||||
apply = mapAttrs (k: v: { _file = "${toString self.outPath}/flake.nix#darwinModules.${k}"; imports = [ v ]; });
|
apply = mapAttrs (k: v: { _file = "${toString self.outPath}/flake.nix#darwinModules.${k}"; imports = [ v ]; });
|
||||||
description = lib.mdDoc ''
|
description = ''
|
||||||
[nix-darwin](https://daiderd.com/nix-darwin/) modules.
|
[nix-darwin](https://daiderd.com/nix-darwin/) modules.
|
||||||
'';
|
'';
|
||||||
};
|
};
|
||||||
|
|
|
@ -16,7 +16,7 @@ in
|
||||||
{ freeformType = types.lazyAttrsOf types.raw; }
|
{ freeformType = types.lazyAttrsOf types.raw; }
|
||||||
];
|
];
|
||||||
};
|
};
|
||||||
description = lib.mdDoc ''
|
description = ''
|
||||||
Raw flake output attributes. Any attribute can be set here, but some
|
Raw flake output attributes. Any attribute can be set here, but some
|
||||||
attributes are represented by options, to provide appropriate
|
attributes are represented by options, to provide appropriate
|
||||||
configuration merging.
|
configuration merging.
|
||||||
|
|
|
@ -15,7 +15,7 @@ in
|
||||||
nixosConfigurations = mkOption {
|
nixosConfigurations = mkOption {
|
||||||
type = types.lazyAttrsOf types.raw;
|
type = types.lazyAttrsOf types.raw;
|
||||||
default = { };
|
default = { };
|
||||||
description = lib.mdDoc ''
|
description = ''
|
||||||
Instantiated NixOS configurations. Used by `nixos-rebuild`.
|
Instantiated NixOS configurations. Used by `nixos-rebuild`.
|
||||||
'';
|
'';
|
||||||
example = literalExpression ''
|
example = literalExpression ''
|
||||||
|
|
|
@ -18,7 +18,7 @@ in
|
||||||
type = types.lazyAttrsOf types.unspecified;
|
type = types.lazyAttrsOf types.unspecified;
|
||||||
default = { };
|
default = { };
|
||||||
apply = mapAttrs (k: v: { _file = "${toString self.outPath}/flake.nix#nixosModules.${k}"; imports = [ v ]; });
|
apply = mapAttrs (k: v: { _file = "${toString self.outPath}/flake.nix#nixosModules.${k}"; imports = [ v ]; });
|
||||||
description = lib.mdDoc ''
|
description = ''
|
||||||
NixOS modules.
|
NixOS modules.
|
||||||
|
|
||||||
You may use this for reusable pieces of configuration, service modules, etc.
|
You may use this for reusable pieces of configuration, service modules, etc.
|
||||||
|
|
|
@ -23,7 +23,7 @@ in
|
||||||
default = final: prev: {};
|
default = final: prev: {};
|
||||||
}
|
}
|
||||||
'';
|
'';
|
||||||
description = lib.mdDoc ''
|
description = ''
|
||||||
An attribute set of [overlays](https://nixos.org/manual/nixpkgs/stable/#chap-overlays).
|
An attribute set of [overlays](https://nixos.org/manual/nixpkgs/stable/#chap-overlays).
|
||||||
|
|
||||||
Note that the overlays themselves are not mergeable. While overlays
|
Note that the overlays themselves are not mergeable. While overlays
|
||||||
|
|
|
@ -16,7 +16,7 @@ in
|
||||||
{
|
{
|
||||||
options = {
|
options = {
|
||||||
systems = mkOption {
|
systems = mkOption {
|
||||||
description = lib.mdDoc ''
|
description = ''
|
||||||
All the system types to enumerate in the flake output subattributes.
|
All the system types to enumerate in the flake output subattributes.
|
||||||
|
|
||||||
In other words, all valid values for `system` in e.g. `packages.<system>.foo`.
|
In other words, all valid values for `system` in e.g. `packages.<system>.foo`.
|
||||||
|
@ -25,12 +25,12 @@ in
|
||||||
};
|
};
|
||||||
|
|
||||||
perInput = mkOption {
|
perInput = mkOption {
|
||||||
description = lib.mdDoc "Function from system to function from flake to `system`-specific attributes.";
|
description = "Function from system to function from flake to `system`-specific attributes.";
|
||||||
type = types.functionTo (types.functionTo (types.lazyAttrsOf types.unspecified));
|
type = types.functionTo (types.functionTo (types.lazyAttrsOf types.unspecified));
|
||||||
};
|
};
|
||||||
|
|
||||||
perSystem = mkOption {
|
perSystem = mkOption {
|
||||||
description = lib.mdDoc "A function from system to flake-like attributes omitting the `<system>` attribute.";
|
description = "A function from system to flake-like attributes omitting the `<system>` attribute.";
|
||||||
type = mkPerSystemType ({ config, system, ... }: {
|
type = mkPerSystemType ({ config, system, ... }: {
|
||||||
_file = ./perSystem.nix;
|
_file = ./perSystem.nix;
|
||||||
config = {
|
config = {
|
||||||
|
@ -50,7 +50,7 @@ in
|
||||||
|
|
||||||
allSystems = mkOption {
|
allSystems = mkOption {
|
||||||
type = types.lazyAttrsOf types.unspecified;
|
type = types.lazyAttrsOf types.unspecified;
|
||||||
description = lib.mdDoc "The system-specific config for each of systems.";
|
description = "The system-specific config for each of systems.";
|
||||||
internal = true;
|
internal = true;
|
||||||
};
|
};
|
||||||
};
|
};
|
||||||
|
|
|
@ -17,7 +17,7 @@ let
|
||||||
adHoc = mkOption {
|
adHoc = mkOption {
|
||||||
type = types.bool;
|
type = types.bool;
|
||||||
default = false;
|
default = false;
|
||||||
description = lib.mdDoc ''
|
description = ''
|
||||||
Whether to provide a stub option declaration for {option}`perSystem.<name>`.
|
Whether to provide a stub option declaration for {option}`perSystem.<name>`.
|
||||||
|
|
||||||
The stub option declaration does not support merging and lacks
|
The stub option declaration does not support merging and lacks
|
||||||
|
@ -32,7 +32,7 @@ in
|
||||||
{
|
{
|
||||||
options = {
|
options = {
|
||||||
transposition = lib.mkOption {
|
transposition = lib.mkOption {
|
||||||
description = lib.mdDoc ''
|
description = ''
|
||||||
A helper that defines transposed attributes in the flake outputs.
|
A helper that defines transposed attributes in the flake outputs.
|
||||||
|
|
||||||
Transposition is the operation that swaps the indices of a data structure.
|
Transposition is the operation that swaps the indices of a data structure.
|
||||||
|
|
Loading…
Reference in a new issue