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

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

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

2
modules/home-environment.nix
View file

@ -383,7 +383,7 @@ in
unexpected state is found. For example, the unexpected state is found. For example, the
<literal>checkLinkTargets</literal> script block checks for <literal>checkLinkTargets</literal> script block checks for
collisions between non-managed files and files defined in 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> </para><para>

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

@ -33,7 +33,7 @@ in
type = types.nullOr types.lines; type = types.nullOr types.lines;
description = '' description = ''
Text of the file. If this option is null then 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. must be set.
''; '';
}; };
@ -42,7 +42,7 @@ in
type = types.path; type = types.path;
description = '' description = ''
Path of the source file or directory. If 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 is non-null then this option will automatically point to a file
containing that text. containing that text.
''; '';

2
modules/programs/firefox.nix
View file

@ -176,7 +176,7 @@ in {
Extensions listed here will only be available in Firefox Extensions listed here will only be available in Firefox
profiles managed through the 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 option. This is due to recent changes in the way Firefox
handles extension side-loading. handles extension side-loading.
''; '';

7
modules/programs/go.nix
View file

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

2
modules/programs/zsh.nix
View file

@ -246,7 +246,7 @@ in
} }
''; '';
description = '' 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. but are substituted anywhere on a line.
''; '';
type = types.attrsOf types.str; type = types.attrsOf types.str;

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

@ -67,7 +67,7 @@ let
default = null; default = null;
description = '' description = ''
Launch application on a particular workspace. DEPRECATED: 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"/>. instead. See <link xlink:href="https://github.com/nix-community/home-manager/issues/265"/>.
''; '';
}; };