colin/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

nixos/*: replace <replaceable>s with «thing»

Browse Source 
we can't embed syntactic annotations of this kind in markdown code
blocks without yet another extension. replaceable is rare enough to make
this not much worth it, so we'll go with «thing» instead. the module
system already uses this format for its placeholder names in attrsOf
paths.
This commit is contained in:
pennae 2022-08-03 01:57:59 +02:00
parent 16102dce2f
commit 9c8531c8a5
18 changed files with 35 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
nixos/modules/config/users-groups.nix
View File

@ -105,7 +105,7 @@ let
automatically sets <option>group</option> to
<literal>users</literal>, <option>createHome</option> to
<literal>true</literal>, <option>home</option> to
<filename>/home/<replaceable>username</replaceable></filename>,
<filename>/home/«username»</filename>,
<option>useDefaultShell</option> to <literal>true</literal>,
and <option>isSystemUser</option> to
<literal>false</literal>.

2
nixos/modules/hardware/video/uvcvideo/default.nix
View File

@ -37,7 +37,7 @@ in
description = ''
List of packages containing <command>uvcvideo</command> dynamic controls
rules. All files found in
<filename><replaceable>pkg</replaceable>/share/uvcdynctrl/data</filename>
<filename>«pkg»/share/uvcdynctrl/data</filename>
will be included.
Note that these will serve as input to the <command>libwebcam</command>

2
nixos/modules/programs/neovim.nix
View File

@ -74,7 +74,7 @@ in {
'';
description = ''
Generate your init file from your list of plugins and custom commands.
Neovim will then be wrapped to load <command>nvim -u /nix/store/<replaceable>hash</replaceable>-vimrc</command>
Neovim will then be wrapped to load <command>nvim -u /nix/store/«hash»-vimrc</command>
'';
};

2
nixos/modules/security/dhparams.nix
View File

@ -61,7 +61,7 @@ in {
The value is the size (in bits) of the DH params to generate. The
generated DH params path can be found in
<literal>config.security.dhparams.params.<replaceable>name</replaceable>.path</literal>.
<literal>config.security.dhparams.params.«name».path</literal>.
<note><para>The name of the DH params is taken as being the name of
the service it serves and the params will be generated before the

6
nixos/modules/services/backup/duplicity.nix
View File

@ -63,9 +63,9 @@ in
<citerefentry><refentrytitle>systemd.exec</refentrytitle>
<manvolnum>5</manvolnum></citerefentry>. For example:
<programlisting>
PASSPHRASE=<replaceable>...</replaceable>
AWS_ACCESS_KEY_ID=<replaceable>...</replaceable>
AWS_SECRET_ACCESS_KEY=<replaceable>...</replaceable>
PASSPHRASE=«...»
AWS_ACCESS_KEY_ID=«...»
AWS_SECRET_ACCESS_KEY=«...»
</programlisting>
'';
};

4
nixos/modules/services/backup/syncoid.nix
View File

@ -194,8 +194,8 @@ in
example = "user@server:pool/dataset";
description = ''
Target ZFS dataset. Can be either local
(<replaceable>pool/dataset</replaceable>) or remote
(<replaceable>user@server:pool/dataset</replaceable>).
(«pool/dataset») or remote
(«user@server:pool/dataset»).
'';
};

8
nixos/modules/services/hardware/udev.nix
View File

@ -212,8 +212,8 @@ in
description = ''
List of packages containing <command>udev</command> rules.
All files found in
<filename><replaceable>pkg</replaceable>/etc/udev/rules.d</filename> and
<filename><replaceable>pkg</replaceable>/lib/udev/rules.d</filename>
<filename>«pkg»/etc/udev/rules.d</filename> and
<filename>«pkg»/lib/udev/rules.d</filename>
will be included.
'';
apply = map getBin;
@ -306,8 +306,8 @@ in
List of packages containing <command>udev</command> rules that will be copied to stage 1.
All files found in
<filename><replaceable>pkg</replaceable>/etc/udev/rules.d</filename> and
<filename><replaceable>pkg</replaceable>/lib/udev/rules.d</filename>
<filename>«pkg»/etc/udev/rules.d</filename> and
<filename>«pkg»/lib/udev/rules.d</filename>
will be included.
'';
};

2
nixos/modules/services/mail/sympa.nix
View File

@ -242,7 +242,7 @@ in
description = ''
The webserver used for the Sympa web interface. Set it to `none` if you want to configure it yourself.
Further nginx configuration can be done by adapting
<option>services.nginx.virtualHosts.<replaceable>name</replaceable></option>.
<option>services.nginx.virtualHosts.«name»</option>.
'';
};

4
nixos/modules/services/networking/hans.nix
View File

@ -23,8 +23,8 @@ in
Each attribute of this option defines a systemd service that
runs hans. Many or none may be defined.
The name of each service is
<literal>hans-<replaceable>name</replaceable></literal>
where <replaceable>name</replaceable> is the name of the
<literal>hans-«name»</literal>
where «name» is the name of the
corresponding attribute name.
'';
example = literalExpression ''

4
nixos/modules/services/networking/iodine.nix
View File

@ -32,8 +32,8 @@ in
Each attribute of this option defines a systemd service that
runs iodine. Many or none may be defined.
The name of each service is
<literal>iodine-<replaceable>name</replaceable></literal>
where <replaceable>name</replaceable> is the name of the
<literal>iodine-«name»</literal>
where «name» is the name of the
corresponding attribute name.
'';
example = literalExpression ''

4
nixos/modules/services/networking/openvpn.nix
View File

@ -119,8 +119,8 @@ in
Each attribute of this option defines a systemd service that
runs an OpenVPN instance. These can be OpenVPN servers or
clients. The name of each systemd service is
<literal>openvpn-<replaceable>name</replaceable>.service</literal>,
where <replaceable>name</replaceable> is the corresponding
<literal>openvpn-«name».service</literal>,
where «name» is the corresponding
attribute name.
'';

12
nixos/modules/services/system/dbus.nix
View File

@ -43,12 +43,12 @@ in
the configuration of the D-Bus system-wide or session-wide
message bus. Specifically, files in the following directories
will be included into their respective DBus configuration paths:
<filename><replaceable>pkg</replaceable>/etc/dbus-1/system.d</filename>
<filename><replaceable>pkg</replaceable>/share/dbus-1/system.d</filename>
<filename><replaceable>pkg</replaceable>/share/dbus-1/system-services</filename>
<filename><replaceable>pkg</replaceable>/etc/dbus-1/session.d</filename>
<filename><replaceable>pkg</replaceable>/share/dbus-1/session.d</filename>
<filename><replaceable>pkg</replaceable>/share/dbus-1/services</filename>
<filename>«pkg»/etc/dbus-1/system.d</filename>
<filename>«pkg»/share/dbus-1/system.d</filename>
<filename>«pkg»/share/dbus-1/system-services</filename>
<filename>«pkg»/etc/dbus-1/session.d</filename>
<filename>«pkg»/share/dbus-1/session.d</filename>
<filename>«pkg»/share/dbus-1/services</filename>
'';
};

2
nixos/modules/services/web-servers/apache-httpd/vhost-options.nix
View File

@ -233,7 +233,7 @@ in
default = false;
description = ''
Whether to enable serving <filename>~/public_html</filename> as
<literal>/~<replaceable>username</replaceable></literal>.
<literal>/~«username»</literal>.
'';
};

2
nixos/modules/system/boot/luksroot.nix
View File

@ -552,7 +552,7 @@ in
The encrypted disk that should be opened before the root
filesystem is mounted. Both LVM-over-LUKS and LUKS-over-LVM
setups are supported. The unencrypted devices can be accessed as
<filename>/dev/mapper/<replaceable>name</replaceable></filename>.
<filename>/dev/mapper/«name»</filename>.
'';
type = with types; attrsOf (submodule (

2
nixos/modules/system/boot/stage-1.nix
View File

@ -480,7 +480,7 @@ in
if you want to resume from file. If left empty, the swap partitions are used.
Specify here the device where the file resides.
You should also use <varname>boot.kernelParams</varname> to specify
<literal><replaceable>resume_offset</replaceable></literal>.
<literal>«resume_offset»</literal>.
'';
};

2
nixos/modules/system/boot/systemd/tmpfiles.nix
View File

@ -29,7 +29,7 @@ in
List of packages containing <command>systemd-tmpfiles</command> rules.
All files ending in .conf found in
<filename><replaceable>pkg</replaceable>/lib/tmpfiles.d</filename>
<filename>«pkg»/lib/tmpfiles.d</filename>
will be included.
If this folder does not exist or does not contain any files an error will be returned instead.

4
nixos/modules/virtualisation/nixos-containers.nix
View File

@ -583,7 +583,7 @@ in
Whether to give the container its own private virtual
Ethernet interface. The interface is called
<literal>eth0</literal>, and is hooked up to the interface
<literal>ve-<replaceable>container-name</replaceable></literal>
<literal>ve-«container-name»</literal>
on the host. If this option is not set, then the
container shares the network interfaces of the host,
and can bind to any port on any interface.
@ -731,7 +731,7 @@ in
description = ''
A set of NixOS system configurations to be run as lightweight
containers. Each container appears as a service
<literal>container-<replaceable>name</replaceable></literal>
<literal>container-«name»</literal>
on the host system, allowing it to be started and stopped via
<command>systemctl</command>.
'';

6
nixos/modules/virtualisation/qemu-vm.nix
View File

@ -516,12 +516,12 @@ in
description =
''
Virtual networks to which the VM is connected. Each
number <replaceable>N</replaceable> in this list causes
number «N» in this list causes
the VM to have a virtual Ethernet interface attached to a
separate virtual network on which it will be assigned IP
address
<literal>192.168.<replaceable>N</replaceable>.<replaceable>M</replaceable></literal>,
where <replaceable>M</replaceable> is the index of this VM
<literal>192.168.«N».«M»</literal>,
where «M» is the index of this VM
in the list of VMs.
'';
};