eeva
/
home-manager
mirror of https://github.com/nix-community/home-manager
1
0
Fork 0
Code Issues Releases Wiki Activity

treewide: replace <link> by <xref> where appropriate

This commit is contained in:
Robert Helgesson 2022-08-26 00:07:08 +02:00
parent 7bb4576f46
commit 76fbb1b15e
No known key found for this signature in database
GPG Key ID: 36BDAA14C2797E89
7 changed files with 11 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
modules/config/home-cursor.nix
View File

@ -101,9 +101,9 @@ in {
options. Options declared under namespaces such as <literal>x11</literal>
are backend specific options. By default, only backend independent cursor
configurations are generated. If you need configurations for specific
backends, you can toggle them via the enable option. For example, <varname>
<link linkend="opt-home.pointerCursor.x11.enable">home.pointerCursor.x11.enable</link>
</varname> will enable x11 cursor configurations.
backends, you can toggle them via the enable option. For example,
<xref linkend="opt-home.pointerCursor.x11.enable"/>
will enable x11 cursor configurations.
'';
};
};

2
modules/home-environment.nix
View File

@ -383,7 +383,7 @@ in
unexpected state is found. For example, the
<literal>checkLinkTargets</literal> script block checks for
collisions between non-managed files and files defined in
<varname><link linkend="opt-home.file">home.file</link></varname>.
<xref linkend="opt-home.file"/>.
</para><para>

4
modules/lib/file-type.nix
View File

@ -33,7 +33,7 @@ in
type = types.nullOr types.lines;
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>
<xref linkend="opt-home.file._name_.source"/>
must be set.
'';
};
@ -42,7 +42,7 @@ in
type = types.path;
description = ''
Path of the source file or directory. If
<link linkend="opt-home.file._name_.text">home.file.&lt;name?&gt;.text</link>
<xref linkend="opt-home.file._name_.text"/>
is non-null then this option will automatically point to a file
containing that text.
'';

2
modules/programs/firefox.nix
View File

@ -176,7 +176,7 @@ in {
Extensions listed here will only be available in Firefox
profiles managed through the
<link linkend="opt-programs.firefox.profiles">programs.firefox.profiles</link>
<xref linkend="opt-programs.firefox.profiles"/>
option. This is due to recent changes in the way Firefox
handles extension side-loading.
'';

7
modules/programs/go.nix
View File

@ -47,12 +47,9 @@ in {
type = types.listOf types.str;
default = [ ];
example = [ "extraGoPath1" "extraGoPath2" ];
description = let goPathOpt = "programs.go.goPath";
in ''
description = ''
Extra <envar>GOPATH</envar>s relative to <envar>HOME</envar> appended
after
<varname><link linkend="opt-${goPathOpt}">${goPathOpt}</link></varname>,
if that option is set.
after <xref linkend="opt-programs.go.goPath"/>, if that option is set.
'';
};

2
modules/programs/zsh.nix
View File

@ -246,7 +246,7 @@ in
}
'';
description = ''
Similar to <varname><link linkend="opt-programs.zsh.shellAliases">opt-programs.zsh.shellAliases</link></varname>,
Similar to <xref linkend="opt-programs.zsh.shellAliases"/>,
but are substituted anywhere on a line.
'';
type = types.attrsOf types.str;

2
modules/services/window-managers/i3-sway/lib/options.nix
View File

@ -67,7 +67,7 @@ let
default = null;
description = ''
Launch application on a particular workspace. DEPRECATED:
Use <varname><link linkend="opt-xsession.windowManager.i3.config.assigns">xsession.windowManager.i3.config.assigns</link></varname>
Use <xref linkend="opt-xsession.windowManager.i3.config.assigns"/>
instead. See <link xlink:href="https://github.com/nix-community/home-manager/issues/265"/>.
'';
};