1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-11-30 06:59:45 +01:00

Files: Add symlinkJoin to documentation

Doing so helps newcommers to overcome the "targets are unique among home.file directives" restriction with what tools already exist
This commit is contained in:
niacdoial 2022-09-18 15:57:10 +02:00
parent 27981ab4a2
commit 29c6eb1d2d
No known key found for this signature in database
GPG key ID: D2B9B9FE6D7B1C8E

View file

@ -25,6 +25,13 @@ in
defaultText = literalExpression "<name>";
description = ''
Path to target file relative to ${basePathDesc}.
</para><para>
Please note that only a single
<xref linkend="opt-home.file"/> directive
may write to a given target.
In order to link several directories to the same place, you may use
<literal>symlinkJoin</literal> as such:</para><para>
<literal>source = pkgs.symlinkJoin{name="myjoin"; dirs=[ home-package /some/path ]; postBuild="echo custom shell script here";};</literal>
'';
};