Mirrors/home-manager
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

lib/file-type: fix xrefs (#4007)

Browse source 
Currently they all point to `home.file`.
This commit is contained in:
Naïm Favier 2023-05-22 22:48:23 +02:00 committed by GitHub
parent ba006d7cca
commit d9995d94f1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
modules/files.nix
View file

@ -28,7 +28,7 @@ in
home.file = mkOption {
description = "Attribute set of files to link into the user home.";
default = {};
type = fileType "<envar>HOME</envar>" homeDirectory;
type = fileType "home.file" "<envar>HOME</envar>" homeDirectory;
};
home-files = mkOption {

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

@ -10,9 +10,10 @@ in
# absolute path).
#
# Arguments:
# - opt the name of the option, for self-references
# - basePathDesc docbook compatible description of the base path
# - basePath the file base path
fileType = basePathDesc: basePath: types.attrsOf (types.submodule (
fileType = opt: basePathDesc: basePath: types.attrsOf (types.submodule (
{ name, config, ... }: {
options = {
enable = mkOption {
@ -30,7 +31,7 @@ in
absPath = if hasPrefix "/" p then p else "${basePath}/${p}";
in
removePrefix (homeDirectory + "/") absPath;
defaultText = literalExpression "<name>";
defaultText = literalExpression "name";
description = ''
Path to target file relative to ${basePathDesc}.
'';
@ -41,7 +42,7 @@ in
type = types.nullOr types.lines;
description = ''
Text of the file. If this option is null then
<xref linkend="opt-home.file._name_.source"/>
<xref linkend="opt-${opt}._name_.source"/>
must be set.
'';
};
@ -50,7 +51,7 @@ in
type = types.path;
description = ''
Path of the source file or directory. If
<xref linkend="opt-home.file._name_.text"/>
<xref linkend="opt-${opt}._name_.text"/>
is non-null then this option will automatically point to a file
containing that text.
'';

6
modules/misc/xdg.nix
View file

@ -34,7 +34,8 @@ in {
};
configFile = mkOption {
type = fileType "<varname>xdg.configHome</varname>" cfg.configHome;
type = fileType "xdg.configFile" "<varname>xdg.configHome</varname>"
cfg.configHome;
default = { };
description = ''
Attribute set of files to link into the user's XDG
@ -52,7 +53,8 @@ in {
};
dataFile = mkOption {
type = fileType "<varname>xdg.dataHome</varname>" cfg.dataHome;
type =
fileType "xdg.dataFile" "<varname>xdg.dataHome</varname>" cfg.dataHome;
default = { };
description = ''
Attribute set of files to link into the user's XDG

3
modules/programs/neovim.nix
View file

@ -43,7 +43,8 @@ let
default = { };
# passing actual "${xdg.configHome}/nvim" as basePath was a bit tricky
# due to how fileType.target is implemented
type = fileType "<varname>xdg.configHome/nvim</varname>" "nvim";
type = fileType "programs.neovim.plugins._.runtime"
"<varname>xdg.configHome/nvim</varname>" "nvim";
example = literalExpression ''
{ "ftplugin/c.vim".text = "setlocal omnifunc=v:lua.vim.lsp.omnifunc"; }
'';