eeva/home-manager
1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-11-27 05:29:46 +01:00
Code Issues Releases Wiki Activity

files: minor documentation improvements

Browse source
This commit is contained in:
Robert Helgesson 2020-07-31 00:54:23 +02:00
parent bb6eb9b13e
commit 79a2320fd0
No known key found for this signature in database
GPG key ID: 36BDAA14C2797E89
1 changed files with 10 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
modules/lib/file-type.nix
View file

@ -21,6 +21,7 @@ with lib;
absPath = if hasPrefix "/" p then p else "${basePath}/${p}";
in
removePrefix (homeDirectory + "/") absPath;
defaultText = literalExample "<name>";
description = ''
Path to target file relative to ${basePathDesc}.
'';
@ -29,17 +30,20 @@ with lib;
text = mkOption {
default = null;
type = types.nullOr types.lines;
description = "Text of the file.";
description = ''
Text of the file. If this option is null then
<link linkend="opt-home.file._name__.source">home.file.&lt;name?&gt;.source</link>
must be set.
'';
};
source = mkOption {
type = types.path;
description = ''
Path of the source file. The file name must not start
with a period since Nix will not allow such names in
the Nix store.
</para><para>
This may refer to a directory.
Path of the source file or directory. If
<link linkend="opt-home.file._name__.text">home.file.&lt;name?&gt;.text</link>
is non-null then this option will automatically point to a file
containing that text.
'';
};