1
0
Fork 0
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:
Robert Hensing 2022-05-13 10:14:54 +02:00
parent 783e29f7dd
commit 3149d748cb
5 changed files with 11 additions and 11 deletions

View file

@ -48,7 +48,7 @@ in
description = '' description = ''
Programs runnable with nix run <literal>.#&lt;name></literal>. Programs runnable with nix run <literal>.#&lt;name></literal>.
''; '';
example = lib.literalExample '' example = lib.literalExpression or lib.literalExample ''
{ {
x86_64-linux.default.program = "''${config.packages.hello}/bin/hello"; x86_64-linux.default.program = "''${config.packages.hello}/bin/hello";
} }
@ -79,7 +79,7 @@ in
description = '' description = ''
Programs runnable with nix run <literal>.#&lt;name></literal>. Programs runnable with nix run <literal>.#&lt;name></literal>.
''; '';
example = lib.literalExample '' example = lib.literalExpression or lib.literalExample ''
{ {
default.program = "''${config.packages.hello}/bin/hello"; default.program = "''${config.packages.hello}/bin/hello";
} }

View file

@ -19,7 +19,7 @@ in
default = { }; default = { };
description = '' description = ''
Per system an attribute set of packages used as shells. Per system an attribute set of packages used as shells.
nix develop .#<name> will run devShells.<system>.<name>. <literal>nix develop .#&lt;name></literal> will run <literal>devShells.&lt;system>.&lt;name></literal>.
''; '';
}; };
}; };
@ -45,8 +45,8 @@ in
type = types.lazyAttrsOf types.package; type = types.lazyAttrsOf types.package;
default = { }; default = { };
description = '' description = ''
An attribute set of packages to be built by nix develop .#<name>. An attribute set of packages to be built by <literal>nix develop .#&lt;name></literal>.
nix build .#<name> will run devShells.<name>. <literal>nix build .#&lt;name></literal> will run <literal>devShells.&lt;name></literal>.
''; '';
}; };
}; };

View file

@ -18,7 +18,7 @@ in
type = types.lazyAttrsOf (types.lazyAttrsOf types.anything); type = types.lazyAttrsOf (types.lazyAttrsOf types.anything);
default = { }; default = { };
description = '' 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 .#&lt;attrpath></literal>.
''; '';
}; };
}; };
@ -44,7 +44,7 @@ in
type = types.lazyAttrsOf types.anything; type = types.lazyAttrsOf types.anything;
default = { }; default = { };
description = '' 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 .#&lt;attrpath></literal>.
''; '';
}; };
}; };

View file

@ -19,7 +19,7 @@ in
default = { }; default = { };
description = '' description = ''
Per system an attribute set of packages. Per system an attribute set of packages.
nix build .#<name> will build packages.<system>.<name>. <literal>nix build .#&lt;name></literal> will build <literal>packages.&lt;system>.&lt;name></literal>.
''; '';
}; };
}; };
@ -45,8 +45,8 @@ in
type = types.lazyAttrsOf types.package; type = types.lazyAttrsOf types.package;
default = { }; default = { };
description = '' description = ''
An attribute set of packages to be built by nix build .#<name>. An attribute set of packages to be built by <literal>nix build .#&lt;name></literal>.
nix build .#<name> will build packages.<name>. <literal>nix build .#&lt;name></literal> will build <literal>packages.&lt;name></literal>.
''; '';
}; };
}; };

View file

@ -21,7 +21,7 @@ in
}; };
perInput = mkOption { 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)); type = types.functionTo (types.functionTo (types.lazyAttrsOf types.unspecified));
}; };