dev/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

nixos: fix bad mkEnableOption descriptions

Browse Source 
Fix descriptions that don't account for (1) the "Whether to enable"
prefix or (2) the automatically added trailing dot.
This commit is contained in:
Bjørn Forsman 2023-10-18 22:59:26 +02:00 committed by Jörg Thalheim
parent ccf848f9dd
commit 142074c2a8
72 changed files with 121 additions and 121 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
nixos/modules/config/iproute2.nix
View File

@ -7,7 +7,7 @@ let
in
{
options.networking.iproute2 = {
enable = mkEnableOption (lib.mdDoc "copy IP route configuration files");
enable = mkEnableOption (lib.mdDoc "copying IP route configuration files");
rttablesExtraConfig = mkOption {
type = types.lines;
default = "";

2
nixos/modules/config/stevenblack.nix
View File

@ -15,7 +15,7 @@ let
in
{
options.networking.stevenblack = {
enable = mkEnableOption (mdDoc "Enable the stevenblack hosts file blocklist");
enable = mkEnableOption (mdDoc "the stevenblack hosts file blocklist");
block = mkOption {
type = types.listOf (types.enum [ "fakenews" "gambling" "porn" "social" ]);

4
nixos/modules/hardware/corectrl.nix
View File

@ -8,13 +8,13 @@ in
{
options.programs.corectrl = {
enable = mkEnableOption (lib.mdDoc ''
A tool to overclock amd graphics cards and processors.
CoreCtrl, a tool to overclock amd graphics cards and processors.
Add your user to the corectrl group to run corectrl without needing to enter your password
'');
gpuOverclock = {
enable = mkEnableOption (lib.mdDoc ''
true
GPU overclocking
'');
ppfeaturemask = mkOption {
type = types.str;

2
nixos/modules/hardware/i2c.nix
View File

@ -11,7 +11,7 @@ in
enable = mkEnableOption (lib.mdDoc ''
i2c devices support. By default access is granted to users in the "i2c"
group (will be created if non-existent) and any user with a seat, meaning
logged on the computer locally.
logged on the computer locally
'');
group = mkOption {

2
nixos/modules/hardware/keyboard/uhk.nix
View File

@ -11,7 +11,7 @@ in
non-root access to the firmware of UHK keyboards.
You need it when you want to flash a new firmware on the keyboard.
Access to the keyboard is granted to users in the "input" group.
You may want to install the uhk-agent package.
You may want to install the uhk-agent package
'');
};

2
nixos/modules/hardware/keyboard/zsa.nix
View File

@ -11,7 +11,7 @@ in
udev rules for keyboards from ZSA like the ErgoDox EZ, Planck EZ and Moonlander Mark I.
You need it when you want to flash a new configuration on the keyboard
or use their live training in the browser.
You may want to install the wally-cli package.
You may want to install the wally-cli package
'');
};

2
nixos/modules/hardware/openrazer.nix
View File

@ -50,7 +50,7 @@ in
options = {
hardware.openrazer = {
enable = mkEnableOption (lib.mdDoc ''
OpenRazer drivers and userspace daemon.
OpenRazer drivers and userspace daemon
'');
verboseLogging = mkOption {

2
nixos/modules/hardware/tuxedo-keyboard.nix
View File

@ -9,7 +9,7 @@ in
{
options.hardware.tuxedo-keyboard = {
enable = mkEnableOption (lib.mdDoc ''
Enables the tuxedo-keyboard driver.
the tuxedo-keyboard driver.
To configure the driver, pass the options to the {option}`boot.kernelParams` configuration.
There are several parameters you can change. It's best to check at the source code description which options are supported.

26
nixos/modules/hardware/video/nvidia.nix
View File

@ -24,7 +24,7 @@ in {
options = {
hardware.nvidia = {
datacenter.enable = lib.mkEnableOption (lib.mdDoc ''
Data Center drivers for NVIDIA cards on a NVLink topology.
Data Center drivers for NVIDIA cards on a NVLink topology
'');
datacenter.settings = lib.mkOption {
type = settingsFormat.type;
@ -79,18 +79,18 @@ in {
powerManagement.enable = lib.mkEnableOption (lib.mdDoc ''
experimental power management through systemd. For more information, see
the NVIDIA docs, on Chapter 21. Configuring Power Management Support.
the NVIDIA docs, on Chapter 21. Configuring Power Management Support
'');
powerManagement.finegrained = lib.mkEnableOption (lib.mdDoc ''
experimental power management of PRIME offload. For more information, see
the NVIDIA docs, on Chapter 22. PCI-Express Runtime D3 (RTD3) Power Management.
the NVIDIA docs, on Chapter 22. PCI-Express Runtime D3 (RTD3) Power Management
'');
dynamicBoost.enable = lib.mkEnableOption (lib.mdDoc ''
dynamic Boost balances power between the CPU and the GPU for improved
performance on supported laptops using the nvidia-powerd daemon. For more
information, see the NVIDIA docs, on Chapter 23. Dynamic Boost on Linux.
information, see the NVIDIA docs, on Chapter 23. Dynamic Boost on Linux
'');
modesetting.enable = lib.mkEnableOption (lib.mdDoc ''
@ -99,7 +99,7 @@ in {
Enabling this fixes screen tearing when using Optimus via PRIME (see
{option}`hardware.nvidia.prime.sync.enable`. This is not enabled
by default because it is not officially supported by NVIDIA and would not
work with SLI.
work with SLI
'');
prime.nvidiaBusId = lib.mkOption {
@ -153,11 +153,11 @@ in {
Note that this configuration will only be successful when a display manager
for which the {option}`services.xserver.displayManager.setupCommands`
option is supported is used.
option is supported is used
'');
prime.allowExternalGpu = lib.mkEnableOption (lib.mdDoc ''
configuring X to allow external NVIDIA GPUs when using Prime [Reverse] sync optimus.
configuring X to allow external NVIDIA GPUs when using Prime [Reverse] sync optimus
'');
prime.offload.enable = lib.mkEnableOption (lib.mdDoc ''
@ -166,7 +166,7 @@ in {
If this is enabled, then the bus IDs of the NVIDIA and Intel/AMD GPUs have to
be specified ({option}`hardware.nvidia.prime.nvidiaBusId` and
{option}`hardware.nvidia.prime.intelBusId` or
{option}`hardware.nvidia.prime.amdgpuBusId`).
{option}`hardware.nvidia.prime.amdgpuBusId`)
'');
prime.offload.enableOffloadCmd = lib.mkEnableOption (lib.mdDoc ''
@ -174,7 +174,7 @@ in {
for offloading programs to an nvidia device. To work, should have also enabled
{option}`hardware.nvidia.prime.offload.enable` or {option}`hardware.nvidia.prime.reverseSync.enable`.
Example usage `nvidia-offload sauerbraten_client`.
Example usage `nvidia-offload sauerbraten_client`
'');
prime.reverseSync.enable = lib.mkEnableOption (lib.mdDoc ''
@ -202,25 +202,25 @@ in {
Note that this configuration will only be successful when a display manager
for which the {option}`services.xserver.displayManager.setupCommands`
option is supported is used.
option is supported is used
'');
nvidiaSettings =
(lib.mkEnableOption (lib.mdDoc ''
nvidia-settings, NVIDIA's GUI configuration tool.
nvidia-settings, NVIDIA's GUI configuration tool
''))
// {default = true;};
nvidiaPersistenced = lib.mkEnableOption (lib.mdDoc ''
nvidia-persistenced a update for NVIDIA GPU headless mode, i.e.
It ensures all GPUs stay awake even during headless mode.
It ensures all GPUs stay awake even during headless mode
'');
forceFullCompositionPipeline = lib.mkEnableOption (lib.mdDoc ''
forcefully the full composition pipeline.
This sometimes fixes screen tearing issues.
This has been reported to reduce the performance of some OpenGL applications and may produce issues in WebGL.
It also drastically increases the time the driver needs to clock down after load.
It also drastically increases the time the driver needs to clock down after load
'');
package = lib.mkOption {

2
nixos/modules/hardware/video/webcam/facetimehd.nix
View File

@ -12,7 +12,7 @@ in
{
options.hardware.facetimehd.enable = mkEnableOption (lib.mdDoc "facetimehd kernel module");
options.hardware.facetimehd.enable = mkEnableOption (lib.mdDoc "the facetimehd kernel module");
options.hardware.facetimehd.withCalibration = mkOption {
default = false;

2
nixos/modules/misc/nixops-autoluks.nix
View File

@ -5,7 +5,7 @@ let
inherit (config.nixops) enableDeprecatedAutoLuks;
in {
options.nixops.enableDeprecatedAutoLuks = lib.mkEnableOption (lib.mdDoc "Enable the deprecated NixOps AutoLuks module");
options.nixops.enableDeprecatedAutoLuks = lib.mkEnableOption (lib.mdDoc "the deprecated NixOps AutoLuks module");
config = {
assertions = [

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

@ -8,7 +8,7 @@ in {
options = {
programs.calls = {
enable = mkEnableOption (lib.mdDoc ''
Whether to enable GNOME calls: a phone dialer and call handler.
GNOME calls: a phone dialer and call handler
'');
};
};

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

@ -8,7 +8,7 @@ in
{
options = {
programs.cnping = {
enable = mkEnableOption (lib.mdDoc "Whether to install a setcap wrapper for cnping");
enable = mkEnableOption (lib.mdDoc "a setcap wrapper for cnping");
};
};

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

@ -11,7 +11,7 @@ in {
enable = lib.mkEnableOption (lib.mdDoc ''
direnv integration. Takes care of both installation and
setting up the sourcing of the shell. Additionally enables nix-direnv
integration. Note that you need to logout and login for this change to apply.
integration. Note that you need to logout and login for this change to apply
'');
package = lib.mkPackageOptionMD pkgs "direnv" {};

4
nixos/modules/programs/feedbackd.nix
View File

@ -8,9 +8,9 @@ in {
options = {
programs.feedbackd = {
enable = mkEnableOption (lib.mdDoc ''
Whether to enable the feedbackd D-BUS service and udev rules.
the feedbackd D-BUS service and udev rules.
Your user needs to be in the `feedbackd` group to trigger effects.
Your user needs to be in the `feedbackd` group to trigger effects
'');
package = mkOption {
description = lib.mdDoc ''

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

@ -9,7 +9,7 @@ with lib;
1714 to 1764 as they are needed for it to function properly.
You can use the {option}`package` to use
`gnomeExtensions.gsconnect` as an alternative
implementation if you use Gnome.
implementation if you use Gnome
'');
package = mkOption {
default = pkgs.plasma5Packages.kdeconnect-kde;

2
nixos/modules/programs/wayland/wayfire.nix
View File

@ -6,7 +6,7 @@ in
meta.maintainers = with lib.maintainers; [ rewine ];
options.programs.wayfire = {
enable = lib.mkEnableOption (lib.mdDoc "Wayfire, a wayland compositor based on wlroots.");
enable = lib.mkEnableOption (lib.mdDoc "Wayfire, a wayland compositor based on wlroots");
package = lib.mkPackageOptionMD pkgs "wayfire" { };

20
nixos/modules/services/backup/znapzend.nix
View File

@ -359,14 +359,14 @@ in
};
features.oracleMode = mkEnableOption (lib.mdDoc ''
Destroy snapshots one by one instead of using one long argument list.
destroying snapshots one by one instead of using one long argument list.
If source and destination are out of sync for a long time, you may have
so many snapshots to destroy that the argument gets is too long and the
command fails.
command fails
'');
features.recvu = mkEnableOption (lib.mdDoc ''
recvu feature which uses `-u` on the receiving end to keep the destination
filesystem unmounted.
filesystem unmounted
'');
features.compressed = mkEnableOption (lib.mdDoc ''
compressed feature which adds the options `-Lce` to
@ -377,7 +377,7 @@ in
support and -e is for embedded data support. see
{manpage}`znapzend(1)`
and {manpage}`zfs(8)`
for more info.
for more info
'');
features.sendRaw = mkEnableOption (lib.mdDoc ''
sendRaw feature which adds the options `-w` to the
@ -386,25 +386,25 @@ in
backup that can't be read without the encryption key/passphrase, useful
when the remote isn't fully trusted or not physically secure. This
option must be used consistently, raw incrementals cannot be based on
non-raw snapshots and vice versa.
non-raw snapshots and vice versa
'');
features.skipIntermediates = mkEnableOption (lib.mdDoc ''
Enable the skipIntermediates feature to send a single increment
the skipIntermediates feature to send a single increment
between latest common snapshot and the newly made one. It may skip
several source snaps if the destination was offline for some time, and
it should skip snapshots not managed by znapzend. Normally for online
destinations, the new snapshot is sent as soon as it is created on the
source, so there are no automatic increments to skip.
source, so there are no automatic increments to skip
'');
features.lowmemRecurse = mkEnableOption (lib.mdDoc ''
use lowmemRecurse on systems where you have too many datasets, so a
recursive listing of attributes to find backup plans exhausts the
memory available to {command}`znapzend`: instead, go the slower
way to first list all impacted dataset names, and then query their
configs one by one.
configs one by one
'');
features.zfsGetType = mkEnableOption (lib.mdDoc ''
use zfsGetType if your {command}`zfs get` supports a
using zfsGetType if your {command}`zfs get` supports a
`-t` argument for filtering by dataset type at all AND
lists properties for snapshots by default when recursing, so that there
is too much data to process while searching for backup plans.
@ -412,7 +412,7 @@ in
`--recursive` search for backup plans can literally
differ by hundreds of times (depending on the amount of snapshots in
that dataset tree... and a decent backup plan will ensure you have a lot
of those), so you would benefit from requesting this feature.
of those), so you would benefit from requesting this feature
'');
};
};

2
nixos/modules/services/databases/cassandra.nix
View File

@ -122,7 +122,7 @@ in
options.services.cassandra = {
enable = mkEnableOption (lib.mdDoc ''
Apache Cassandra – Scalable and highly available database.
Apache Cassandra – Scalable and highly available database
'');
clusterName = mkOption {

2
nixos/modules/services/databases/ferretdb.nix
View File

@ -11,7 +11,7 @@ in
options = {
services.ferretdb = {
enable = mkEnableOption "FerretDB, an Open Source MongoDB alternative.";
enable = mkEnableOption "FerretDB, an Open Source MongoDB alternative";
package = mkOption {
type = types.package;

2
nixos/modules/services/databases/redis.nix
View File

@ -75,7 +75,7 @@ in {
Note that the NixOS module for Redis disables kernel support
for Transparent Huge Pages (THP),
because this features causes major performance problems for Redis,
e.g. (https://redis.io/topics/latency).
e.g. (https://redis.io/topics/latency)
'');
user = mkOption {

2
nixos/modules/services/databases/surrealdb.nix
View File

@ -8,7 +8,7 @@ in {
options = {
services.surrealdb = {
enable = mkEnableOption (lib.mdDoc "A scalable, distributed, collaborative, document-graph database, for the realtime web ");
enable = mkEnableOption (lib.mdDoc "SurrealDB, a scalable, distributed, collaborative, document-graph database, for the realtime web");
package = mkOption {
default = pkgs.surrealdb;

2
nixos/modules/services/desktops/deepin/app-services.nix
View File

@ -14,7 +14,7 @@ with lib;
services.deepin.app-services = {
enable = mkEnableOption (lib.mdDoc "Service collection of DDE applications, including dconfig-center");
enable = mkEnableOption (lib.mdDoc "service collection of DDE applications, including dconfig-center");
};

4
nixos/modules/services/desktops/deepin/dde-api.nix
View File

@ -15,8 +15,8 @@ with lib;
services.deepin.dde-api = {
enable = mkEnableOption (lib.mdDoc ''
Provides some dbus interfaces that is used for screen zone detecting,
thumbnail generating, and sound playing in Deepin Desktop Environment.
some dbus interfaces that is used for screen zone detecting,
thumbnail generating, and sound playing in Deepin Desktop Environment
'');
};

2
nixos/modules/services/desktops/deepin/dde-daemon.nix
View File

@ -14,7 +14,7 @@ with lib;
services.deepin.dde-daemon = {
enable = mkEnableOption (lib.mdDoc "Daemon for handling the deepin session settings");
enable = mkEnableOption (lib.mdDoc "daemon for handling the deepin session settings");
};

4
nixos/modules/services/desktops/gnome/gnome-browser-connector.nix
View File

@ -24,8 +24,8 @@ in
options = {
services.gnome.gnome-browser-connector.enable = mkEnableOption (mdDoc ''
Native host connector for the GNOME Shell browser extension, a DBus service
allowing to install GNOME Shell extensions from a web browser.
native host connector for the GNOME Shell browser extension, a DBus service
allowing to install GNOME Shell extensions from a web browser
'');
};

2
nixos/modules/services/hardware/supergfxd.nix
View File

@ -7,7 +7,7 @@ in
{
options = {
services.supergfxd = {
enable = lib.mkEnableOption (lib.mdDoc "Enable the supergfxd service");
enable = lib.mkEnableOption (lib.mdDoc "the supergfxd service");
settings = lib.mkOption {
type = lib.types.nullOr json.type;

4
nixos/modules/services/hardware/tuxedo-rs.nix
View File

@ -9,9 +9,9 @@ in
{
options = {
hardware.tuxedo-rs = {
enable = mkEnableOption (lib.mdDoc "Rust utilities for interacting with hardware from TUXEDO Computers.");
enable = mkEnableOption (lib.mdDoc "Rust utilities for interacting with hardware from TUXEDO Computers");
tailor-gui.enable = mkEnableOption (lib.mdDoc "Alternative to TUXEDO Control Center, written in Rust.");
tailor-gui.enable = mkEnableOption (lib.mdDoc "tailor-gui, an alternative to TUXEDO Control Center, written in Rust");
};
};

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

@ -302,7 +302,7 @@ in
enablePAM = mkEnableOption (lib.mdDoc "creating a own Dovecot PAM service and configure PAM user logins") // { default = true; };
enableDHE = mkEnableOption (lib.mdDoc "enable ssl_dh and generation of primes for the key exchange") // { default = true; };
enableDHE = mkEnableOption (lib.mdDoc "ssl_dh and generation of primes for the key exchange") // { default = true; };
sieveScripts = mkOption {
type = types.attrsOf types.path;

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

@ -260,7 +260,7 @@ in {
};
serve = {
enable = mkEnableOption (lib.mdDoc "Automatic nginx and uwsgi setup for mailman-web");
enable = mkEnableOption (lib.mdDoc "automatic nginx and uwsgi setup for mailman-web");
virtualRoot = mkOption {
default = "/";

4
nixos/modules/services/matrix/mjolnir.nix
View File

@ -96,8 +96,8 @@ in
type = types.submodule {
options = {
enable = mkEnableOption (lib.mdDoc ''
If true, accessToken is ignored and the username/password below will be
used instead. The access token of the bot will be stored in the dataPath.
ignoring the accessToken. If true, accessToken is ignored and the username/password below will be
used instead. The access token of the bot will be stored in the dataPath
'');
username = mkOption {

4
nixos/modules/services/misc/klipper.nix
View File

@ -111,11 +111,11 @@ in
(submodule {
options = {
enable = mkEnableOption (lib.mdDoc ''
building of firmware for manual flashing.
building of firmware for manual flashing
'');
enableKlipperFlash = mkEnableOption (lib.mdDoc ''
flashings scripts for firmware. This will add `klipper-flash-$mcu` scripts to your environment which can be called to flash the firmware.
Please check the configs at [klipper](https://github.com/Klipper3d/klipper/tree/master/config) whether your board supports flashing via `make flash`.
Please check the configs at [klipper](https://github.com/Klipper3d/klipper/tree/master/config) whether your board supports flashing via `make flash`
'');
serial = mkOption {
type = types.nullOr path;

4
nixos/modules/services/misc/packagekit.nix
View File

@ -40,9 +40,9 @@ in
options.services.packagekit = {
enable = mkEnableOption (lib.mdDoc ''
PackageKit provides a cross-platform D-Bus abstraction layer for
PackageKit, a cross-platform D-Bus abstraction layer for
installing software. Software utilizing PackageKit can install
software regardless of the package manager.
software regardless of the package manager
'');
settings = mkOption {

2
nixos/modules/services/misc/rshim.nix
View File

@ -12,7 +12,7 @@ let
in
{
options.services.rshim = {
enable = lib.mkEnableOption (lib.mdDoc "User-space rshim driver for the BlueField SoC");
enable = lib.mkEnableOption (lib.mdDoc "user-space rshim driver for the BlueField SoC");
package = lib.mkPackageOptionMD pkgs "rshim-user-space" { };

2
nixos/modules/services/misc/sourcehut/default.nix
View File

@ -438,7 +438,7 @@ in
};
options."lists.sr.ht" = commonServiceSettings "lists" // {
allow-new-lists = mkEnableOption (lib.mdDoc "Allow creation of new lists");
allow-new-lists = mkEnableOption (lib.mdDoc "creation of new lists");
notify-from = mkOption {
description = lib.mdDoc "Outgoing email for notifications generated by users.";
type = types.str;

2
nixos/modules/services/misc/tp-auto-kbbl.nix
View File

@ -9,7 +9,7 @@ in {
options = {
services.tp-auto-kbbl = {
enable = mkEnableOption (lib.mdDoc "Auto toggle keyboard back-lighting on Thinkpads (and maybe other laptops) for Linux");
enable = mkEnableOption (lib.mdDoc "auto toggle keyboard back-lighting on Thinkpads (and maybe other laptops) for Linux");
package = mkOption {
type = types.package;

4
nixos/modules/services/misc/zoneminder.nix
View File

@ -67,14 +67,14 @@ in {
options = {
services.zoneminder = with lib; {
enable = lib.mkEnableOption (lib.mdDoc ''
ZoneMinder
ZoneMinder.
If you intend to run the database locally, you should set
`config.services.zoneminder.database.createLocally` to true. Otherwise,
when set to `false` (the default), you will have to create the database
and database user as well as populate the database yourself.
Additionally, you will need to run `zmupdate.pl` yourself when
upgrading to a newer version.
upgrading to a newer version
'');
webserver = mkOption {

6
nixos/modules/services/monitoring/mackerel-agent.nix
View File

@ -11,10 +11,10 @@ in {
# the upstream package runs as root, but doesn't seem to be strictly
# necessary for basic functionality
runAsRoot = mkEnableOption (lib.mdDoc "Whether to run as root");
runAsRoot = mkEnableOption (lib.mdDoc "running as root");
autoRetirement = mkEnableOption (lib.mdDoc ''
Whether to automatically retire the host upon OS shutdown.
retiring the host upon OS shutdown
'');
apiKeyFile = mkOption {
@ -59,7 +59,7 @@ in {
};
options.diagnostic =
mkEnableOption (lib.mdDoc "Collect memory usage for the agent itself");
mkEnableOption (lib.mdDoc "collecting memory usage for the agent itself");
};
};
};

2
nixos/modules/services/monitoring/prometheus/exporters/wireguard.nix
View File

@ -11,7 +11,7 @@ in {
({ options.warnings = options.warnings; options.assertions = options.assertions; })
];
extraOpts = {
verbose = mkEnableOption (lib.mdDoc "Verbose logging mode for prometheus-wireguard-exporter");
verbose = mkEnableOption (lib.mdDoc "verbose logging mode for prometheus-wireguard-exporter");
wireguardConfig = mkOption {
type = with types; nullOr (either path str);

4
nixos/modules/services/network-filesystems/openafs/server.nix
View File

@ -177,13 +177,13 @@ in {
backup = {
enable = mkEnableOption (lib.mdDoc ''
Backup server role. When using OpenAFS built-in buserver, use in conjunction with the
the backup server role. When using OpenAFS built-in buserver, use in conjunction with the
`database` role to maintain the Backup
Database. Normally only used in conjunction with tape storage
or IBM's Tivoli Storage Manager.
For a modern backup server, enable this role and see
{option}`enableFabs`.
{option}`enableFabs`
'');
enableFabs = mkEnableOption (lib.mdDoc ''

2
nixos/modules/services/networking/create_ap.nix
View File

@ -8,7 +8,7 @@ let
in {
options = {
services.create_ap = {
enable = mkEnableOption (lib.mdDoc "setup wifi hotspots using create_ap");
enable = mkEnableOption (lib.mdDoc "setting up wifi hotspots using create_ap");
settings = mkOption {
type = with types; attrsOf (oneOf [ int bool str ]);
default = {};

6
nixos/modules/services/networking/dae.nix
View File

@ -14,7 +14,7 @@ in
options = {
services.dae = with lib;{
enable = mkEnableOption
(mdDoc "A Linux high-performance transparent proxy solution based on eBPF");
(mdDoc "dae, a Linux high-performance transparent proxy solution based on eBPF");
package = mkPackageOptionMD pkgs "dae" { };
@ -46,7 +46,7 @@ in
openFirewall = mkOption {
type = with types; submodule {
options = {
enable = mkEnableOption "enable";
enable = mkEnableOption (mdDoc "opening {option}`port` in the firewall");
port = mkOption {
type = types.port;
description = ''
@ -91,7 +91,7 @@ in
};
disableTxChecksumIpGeneric =
mkEnableOption (mdDoc "See <https://github.com/daeuniverse/dae/issues/43>");
mkEnableOption "" // { description = mdDoc "See <https://github.com/daeuniverse/dae/issues/43>"; };
};
};

8
nixos/modules/services/networking/deconz.nix
View File

@ -54,13 +54,13 @@ in
description = "TCP port for the WebSocket.";
};
openFirewall = lib.mkEnableOption "open up the service ports in the firewall";
openFirewall = lib.mkEnableOption "opening up the service ports in the firewall";
allowRebootSystem = lib.mkEnableOption "allow rebooting the system";
allowRebootSystem = lib.mkEnableOption "rebooting the system";
allowRestartService = lib.mkEnableOption "allow killing/restarting processes";
allowRestartService = lib.mkEnableOption "killing/restarting processes";
allowSetSystemTime = lib.mkEnableOption "allow setting the system time";
allowSetSystemTime = lib.mkEnableOption "setting the system time";
extraArgs = lib.mkOption {
type = lib.types.listOf lib.types.str;

2
nixos/modules/services/networking/go-neb.nix
View File

@ -9,7 +9,7 @@ let
configFile = settingsFormat.generate "config.yaml" cfg.config;
in {
options.services.go-neb = {
enable = mkEnableOption (lib.mdDoc "Extensible matrix bot written in Go");
enable = mkEnableOption (lib.mdDoc "an extensible matrix bot written in Go");
bindAddress = mkOption {
type = types.str;

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

@ -116,10 +116,10 @@ in {
options = {
services.hostapd = {
enable = mkEnableOption (mdDoc ''
Whether to enable hostapd. hostapd is a user space daemon for access point and
hostapd, a user space daemon for access point and
authentication servers. It implements IEEE 802.11 access point management,
IEEE 802.1X/WPA/WPA2/EAP Authenticators, RADIUS client, EAP server, and RADIUS
authentication server.
authentication server
'');
package = mkPackageOption pkgs "hostapd" {};

8
nixos/modules/services/networking/hylafax/options.nix
View File

@ -272,18 +272,18 @@ in
};
faxcron.enable.spoolInit = mkEnableOption (lib.mdDoc ''
Purge old files from the spooling area with
purging old files from the spooling area with
{file}`faxcron`
each time the spooling area is initialized.
each time the spooling area is initialized
'');
faxcron.enable.frequency = mkOption {
type = nullOr nonEmptyStr;
default = null;
example = "daily";
description = lib.mdDoc ''
Purge old files from the spooling area with
purging old files from the spooling area with
{file}`faxcron` with the given frequency
(see systemd.time(7)).
(see systemd.time(7))
'';
};
faxcron.infoDays = mkOption {

8
nixos/modules/services/networking/i2pd.nix
View File

@ -265,7 +265,7 @@ in
'';
};
logCLFTime = mkEnableOption (lib.mdDoc "Full CLF-formatted date and time to log");
logCLFTime = mkEnableOption (lib.mdDoc "full CLF-formatted date and time to log");
address = mkOption {
type = with types; nullOr str;
@ -456,7 +456,7 @@ in
'';
};
trust.enable = mkEnableOption (lib.mdDoc "Explicit trust options");
trust.enable = mkEnableOption (lib.mdDoc "explicit trust options");
trust.family = mkOption {
type = with types; nullOr str;
@ -474,7 +474,7 @@ in
'';
};
trust.hidden = mkEnableOption (lib.mdDoc "Router concealment");
trust.hidden = mkEnableOption (lib.mdDoc "router concealment");
websocket = mkEndpointOpt "websockets" "127.0.0.1" 7666;
@ -552,7 +552,7 @@ in
proto.http = (mkEndpointOpt "http" "127.0.0.1" 7070) // {
auth = mkEnableOption (lib.mdDoc "Webconsole authentication");
auth = mkEnableOption (lib.mdDoc "webconsole authentication");
user = mkOption {
type = types.str;

2
nixos/modules/services/networking/iscsi/initiator.nix
View File

@ -7,7 +7,7 @@ in
enable = mkEnableOption (lib.mdDoc "the openiscsi iscsi daemon");
enableAutoLoginOut = mkEnableOption (lib.mdDoc ''
automatic login and logout of all automatic targets.
You probably do not want this.
You probably do not want this
'');
discoverPortal = mkOption {
type = nullOr str;

2
nixos/modules/services/networking/nar-serve.nix
View File

@ -10,7 +10,7 @@ in
};
options = {
services.nar-serve = {
enable = mkEnableOption (lib.mdDoc "Serve NAR file contents via HTTP");
enable = mkEnableOption (lib.mdDoc "serving NAR file contents via HTTP");
port = mkOption {
type = types.port;

2
nixos/modules/services/networking/nftables.nix
View File

@ -103,7 +103,7 @@ in
'';
};
networking.nftables.flushRuleset = mkEnableOption (lib.mdDoc "Flush the entire ruleset on each reload.");
networking.nftables.flushRuleset = mkEnableOption (lib.mdDoc "flushing the entire ruleset on each reload");
networking.nftables.extraDeletions = mkOption {
type = types.lines;

2
nixos/modules/services/networking/snowflake-proxy.nix
View File

@ -8,7 +8,7 @@ in
{
options = {
services.snowflake-proxy = {
enable = mkEnableOption (lib.mdDoc "System to defeat internet censorship");
enable = mkEnableOption (lib.mdDoc "snowflake-proxy, a system to defeat internet censorship");
broker = mkOption {
description = lib.mdDoc "Broker URL (default \"https://snowflake-broker.torproject.net/\")";

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

@ -116,9 +116,9 @@ in
};
persistentKeys = mkEnableOption (lib.mdDoc ''
If enabled then keys will be generated once and Yggdrasil
persistent keys. If enabled then keys will be generated once and Yggdrasil
will retain the same IPv6 address when the service is
restarted. Keys are stored at ${keysPath}.
restarted. Keys are stored at ${keysPath}
'');
extraArgs = mkOption {

2
nixos/modules/services/system/earlyoom.nix
View File

@ -11,7 +11,7 @@ let
in
{
options.services.earlyoom = {
enable = mkEnableOption (lib.mdDoc "Early out of memory killing");
enable = mkEnableOption (lib.mdDoc "early out of memory killing");
freeMemThreshold = mkOption {
type = types.ints.between 1 100;

2
nixos/modules/services/system/systembus-notify.nix
View File

@ -13,7 +13,7 @@ in
WARNING: enabling this option (while convenient) should *not* be done on a
machine where you do not trust the other users as it allows any other
local user to DoS your session by spamming notifications.
local user to DoS your session by spamming notifications
'');
};

2
nixos/modules/services/torrent/flexget.nix
View File

@ -14,7 +14,7 @@ let
in {
options = {
services.flexget = {
enable = mkEnableOption (lib.mdDoc "Run FlexGet Daemon");
enable = mkEnableOption (lib.mdDoc "FlexGet daemon");
package = mkPackageOptionMD pkgs "flexget" {};

2
nixos/modules/services/video/mediamtx.nix
View File

@ -40,7 +40,7 @@ in
};
allowVideoAccess = lib.mkEnableOption (lib.mdDoc ''
Enable access to video devices like cameras on the system.
access to video devices like cameras on the system
'');
};
};

2
nixos/modules/services/web-apps/cloudlog.nix
View File

@ -69,7 +69,7 @@ let
in
{
options.services.cloudlog = with types; {
enable = mkEnableOption (mdDoc "Whether to enable Cloudlog");
enable = mkEnableOption (mdDoc "Cloudlog");
dataDir = mkOption {
type = str;
default = "/var/lib/cloudlog";

2
nixos/modules/services/web-apps/hledger-web.nix
View File

@ -7,7 +7,7 @@ in {
enable = mkEnableOption (lib.mdDoc "hledger-web service");
serveApi = mkEnableOption (lib.mdDoc "Serve only the JSON web API, without the web UI");
serveApi = mkEnableOption (lib.mdDoc "serving only the JSON web API, without the web UI");
host = mkOption {
type = types.str;

4
nixos/modules/services/web-apps/isso.nix
View File

@ -12,11 +12,11 @@ in {
options = {
services.isso = {
enable = mkEnableOption (lib.mdDoc ''
A commenting server similar to Disqus.
isso, a commenting server similar to Disqus.
Note: The application's author suppose to run isso behind a reverse proxy.
The embedded solution offered by NixOS is also only suitable for small installations
below 20 requests per second.
below 20 requests per second
'');
settings = mkOption {

4
nixos/modules/services/web-apps/jitsi-meet.nix
View File

@ -105,9 +105,9 @@ in
type = bool;
default = true;
description = lib.mdDoc ''
Whether to enable Jitsi Videobridge instance and configure it to connect to Prosody.
Jitsi Videobridge instance and configure it to connect to Prosody.
Additional configuration is possible with {option}`services.jitsi-videobridge`.
Additional configuration is possible with {option}`services.jitsi-videobridge`
'';
};

4
nixos/modules/services/web-apps/meme-bingo-web.nix
View File

@ -8,9 +8,9 @@ in {
options = {
services.meme-bingo-web = {
enable = mkEnableOption (mdDoc ''
A web app for the meme bingo, rendered entirely on the web server and made interactive with forms.
a web app for the meme bingo, rendered entirely on the web server and made interactive with forms.
Note: The application's author suppose to run meme-bingo-web behind a reverse proxy for SSL and HTTP/3.
Note: The application's author suppose to run meme-bingo-web behind a reverse proxy for SSL and HTTP/3
'');
package = mkOption {

2
nixos/modules/services/web-apps/phylactery.nix
View File

@ -4,7 +4,7 @@ with lib;
let cfg = config.services.phylactery;
in {
options.services.phylactery = {
enable = mkEnableOption (lib.mdDoc "Whether to enable Phylactery server");
enable = mkEnableOption (lib.mdDoc "Phylactery server");
host = mkOption {
type = types.str;

2
nixos/modules/services/web-apps/snipe-it.nix
View File

@ -30,7 +30,7 @@ let
in {
options.services.snipe-it = {
enable = mkEnableOption (lib.mdDoc "A free open source IT asset/license management system");
enable = mkEnableOption (lib.mdDoc "snipe-it, a free open source IT asset/license management system");
user = mkOption {
default = "snipeit";

2
nixos/modules/services/web-apps/zitadel.nix
View File

@ -9,7 +9,7 @@ in
options.services.zitadel =
let inherit (lib) mkEnableOption mkOption mkPackageOption types;
in {
enable = mkEnableOption "ZITADEL, a user and identity access management platform.";
enable = mkEnableOption "ZITADEL, a user and identity access management platform";
package = mkPackageOption pkgs "ZITADEL" { default = [ "zitadel" ]; };

2
nixos/modules/services/web-servers/keter/default.nix
View File

@ -16,7 +16,7 @@ in
options.services.keter = {
enable = lib.mkEnableOption (lib.mdDoc ''keter, a web app deployment manager.
Note that this module only support loading of webapps:
Keep an old app running and swap the ports when the new one is booted.
Keep an old app running and swap the ports when the new one is booted
'');
root = lib.mkOption {

2
nixos/modules/services/web-servers/rustus.nix
View File

@ -8,7 +8,7 @@ in
options.services.rustus = {
enable = mkEnableOption (lib.mdDoc "TUS protocol implementation in Rust.");
enable = mkEnableOption (lib.mdDoc "TUS protocol implementation in Rust");
host = mkOption {
type = types.str;

2
nixos/modules/services/x11/desktop-managers/deepin.nix
View File

@ -15,7 +15,7 @@ in
options = {
services.xserver.desktopManager.deepin = {
enable = mkEnableOption (lib.mdDoc "Enable Deepin desktop manager");
enable = mkEnableOption (lib.mdDoc "Deepin desktop manager");
extraGSettingsOverrides = mkOption {
default = "";
type = types.lines;

2
nixos/modules/system/activation/bootspec.nix
View File

@ -79,7 +79,7 @@ in
// { default = true; internal = true; };
enableValidation = lib.mkEnableOption (lib.mdDoc ''the validation of bootspec documents for each build.
This will introduce Go in the build-time closure as we are relying on [Cuelang](https://cuelang.org/) for schema validation.
Enable this option if you want to ascertain that your documents are correct.
Enable this option if you want to ascertain that your documents are correct
''
);

2
nixos/modules/system/boot/grow-partition.nix
View File

@ -12,7 +12,7 @@ with lib;
];
options = {
boot.growPartition = mkEnableOption (lib.mdDoc "grow the root partition on boot");
boot.growPartition = mkEnableOption (lib.mdDoc "growing the root partition on boot");
};
config = mkIf config.boot.growPartition {

2
nixos/modules/system/boot/loader/external/external.nix vendored
View File

@ -12,7 +12,7 @@ in
};
options.boot.loader.external = {
enable = mkEnableOption (lib.mdDoc "use an external tool to install your bootloader");
enable = mkEnableOption (lib.mdDoc "using an external tool to install your bootloader");
installHook = mkOption {
type = with types; path;

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

@ -5,7 +5,7 @@ let
in
{
options.services.homed.enable = lib.mkEnableOption (lib.mdDoc ''
Enable systemd home area/user account manager
systemd home area/user account manager
'');
config = lib.mkIf cfg.enable {

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

@ -5,7 +5,7 @@ let
in
{
options.services.userdbd.enable = lib.mkEnableOption (lib.mdDoc ''
Enables the systemd JSON user/group record lookup service
the systemd JSON user/group record lookup service
'');
config = lib.mkIf cfg.enable {
systemd.additionalUpstreamSystemUnits = [