mirror of
https://github.com/hercules-ci/flake-parts.git
synced 2024-12-14 11:47:31 +00:00
Fix docbook syntax and literalExample deprecation
This commit is contained in:
parent
783e29f7dd
commit
3149d748cb
5 changed files with 11 additions and 11 deletions
|
@ -48,7 +48,7 @@ in
|
|||
description = ''
|
||||
Programs runnable with nix run <literal>.#<name></literal>.
|
||||
'';
|
||||
example = lib.literalExample ''
|
||||
example = lib.literalExpression or lib.literalExample ''
|
||||
{
|
||||
x86_64-linux.default.program = "''${config.packages.hello}/bin/hello";
|
||||
}
|
||||
|
@ -79,7 +79,7 @@ in
|
|||
description = ''
|
||||
Programs runnable with nix run <literal>.#<name></literal>.
|
||||
'';
|
||||
example = lib.literalExample ''
|
||||
example = lib.literalExpression or lib.literalExample ''
|
||||
{
|
||||
default.program = "''${config.packages.hello}/bin/hello";
|
||||
}
|
||||
|
|
|
@ -19,7 +19,7 @@ in
|
|||
default = { };
|
||||
description = ''
|
||||
Per system an attribute set of packages used as shells.
|
||||
nix develop .#<name> will run devShells.<system>.<name>.
|
||||
<literal>nix develop .#<name></literal> will run <literal>devShells.<system>.<name></literal>.
|
||||
'';
|
||||
};
|
||||
};
|
||||
|
@ -45,8 +45,8 @@ in
|
|||
type = types.lazyAttrsOf types.package;
|
||||
default = { };
|
||||
description = ''
|
||||
An attribute set of packages to be built by nix develop .#<name>.
|
||||
nix build .#<name> will run devShells.<name>.
|
||||
An attribute set of packages to be built by <literal>nix develop .#<name></literal>.
|
||||
<literal>nix build .#<name></literal> will run <literal>devShells.<name></literal>.
|
||||
'';
|
||||
};
|
||||
};
|
||||
|
|
|
@ -18,7 +18,7 @@ in
|
|||
type = types.lazyAttrsOf (types.lazyAttrsOf types.anything);
|
||||
default = { };
|
||||
description = ''
|
||||
Per system, an attribute set of anything. This is also used by nix build .#<attrpath>.
|
||||
Per system, an attribute set of anything. This is also used by <literal>nix build .#<attrpath></literal>.
|
||||
'';
|
||||
};
|
||||
};
|
||||
|
@ -44,7 +44,7 @@ in
|
|||
type = types.lazyAttrsOf types.anything;
|
||||
default = { };
|
||||
description = ''
|
||||
An attribute set of anything. This is also used by nix build .#<attrpath>.
|
||||
An attribute set of anything. This is also used by <literal>nix build .#<attrpath></literal>.
|
||||
'';
|
||||
};
|
||||
};
|
||||
|
|
|
@ -19,7 +19,7 @@ in
|
|||
default = { };
|
||||
description = ''
|
||||
Per system an attribute set of packages.
|
||||
nix build .#<name> will build packages.<system>.<name>.
|
||||
<literal>nix build .#<name></literal> will build <literal>packages.<system>.<name></literal>.
|
||||
'';
|
||||
};
|
||||
};
|
||||
|
@ -45,8 +45,8 @@ in
|
|||
type = types.lazyAttrsOf types.package;
|
||||
default = { };
|
||||
description = ''
|
||||
An attribute set of packages to be built by nix build .#<name>.
|
||||
nix build .#<name> will build packages.<name>.
|
||||
An attribute set of packages to be built by <literal>nix build .#<name></literal>.
|
||||
<literal>nix build .#<name></literal> will build <literal>packages.<name></literal>.
|
||||
'';
|
||||
};
|
||||
};
|
||||
|
|
|
@ -21,7 +21,7 @@ in
|
|||
};
|
||||
|
||||
perInput = mkOption {
|
||||
description = "Function from system to function from flake to system-specific attributes.";
|
||||
description = "Function from system to function from flake to <literal>system</literal>-specific attributes.";
|
||||
type = types.functionTo (types.functionTo (types.lazyAttrsOf types.unspecified));
|
||||
};
|
||||
|
||||
|
|
Loading…
Reference in a new issue