0
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-07-14 14:10:33 +03:00

nixos: remove all uses of lib.mdDoc

these changes were generated with nixq 0.0.2, by running

  nixq ">> lib.mdDoc[remove] Argument[keep]" --batchmode nixos/**.nix
  nixq ">> mdDoc[remove] Argument[keep]" --batchmode nixos/**.nix
  nixq ">> Inherit >> mdDoc[remove]" --batchmode nixos/**.nix

two mentions of the mdDoc function remain in nixos/, both of which
are inside of comments.

Since lib.mdDoc is already defined as just id, this commit is a no-op as
far as Nix (and the built manual) is concerned.
This commit is contained in:
stuebinm 2024-04-13 14:54:15 +02:00 committed by Jonathan Ringer
parent 1dd996e59a
commit 6afb255d97
1701 changed files with 13694 additions and 13865 deletions

View file

@ -13,7 +13,7 @@ in {
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
description = ''
Whether to periodically upgrade NixOS to the latest
version. If enabled, a systemd timer will run
`nixos-rebuild switch --upgrade` once a
@ -25,7 +25,7 @@ in {
type = types.enum ["switch" "boot"];
default = "switch";
example = "boot";
description = lib.mdDoc ''
description = ''
Whether to run
`nixos-rebuild switch --upgrade` or run
`nixos-rebuild boot --upgrade`
@ -36,7 +36,7 @@ in {
type = types.nullOr types.str;
default = null;
example = "github:kloenk/nix";
description = lib.mdDoc ''
description = ''
The Flake URI of the NixOS configuration to build.
Disables the option {option}`system.autoUpgrade.channel`.
'';
@ -46,7 +46,7 @@ in {
type = types.nullOr types.str;
default = null;
example = "https://nixos.org/channels/nixos-14.12-small";
description = lib.mdDoc ''
description = ''
The URI of the NixOS channel to use for automatic
upgrades. By default, this is the channel set using
{command}`nix-channel` (run `nix-channel --list`
@ -64,7 +64,7 @@ in {
"extra-binary-caches"
"http://my-cache.example.org/"
];
description = lib.mdDoc ''
description = ''
Any additional flags passed to {command}`nixos-rebuild`.
If you are using flakes and use a local repo you can add
@ -77,7 +77,7 @@ in {
type = types.str;
default = "04:40";
example = "daily";
description = lib.mdDoc ''
description = ''
How often or when upgrade occurs. For most desktop and server systems
a sufficient upgrade frequency is once a day.
@ -89,7 +89,7 @@ in {
allowReboot = mkOption {
default = false;
type = types.bool;
description = lib.mdDoc ''
description = ''
Reboot the system into the new generation instead of a switch
if the new generation uses a different kernel, kernel modules
or initrd than the booted system.
@ -101,7 +101,7 @@ in {
default = "0";
type = types.str;
example = "45min";
description = lib.mdDoc ''
description = ''
Add a randomized delay before each automatic upgrade.
The delay will be chosen between zero and this value.
This value must be a time span in the format specified by
@ -113,7 +113,7 @@ in {
default = false;
type = types.bool;
example = true;
description = lib.mdDoc ''
description = ''
Make the randomized delay consistent between runs.
This reduces the jitter between automatic upgrades.
See {option}`randomizedDelaySec` for configuring the randomized delay.
@ -121,7 +121,7 @@ in {
};
rebootWindow = mkOption {
description = lib.mdDoc ''
description = ''
Define a lower and upper time value (in HH:MM format) which
constitute a time window during which reboots are allowed after an upgrade.
This option only has an effect when {option}`allowReboot` is enabled.
@ -132,13 +132,13 @@ in {
type = with types; nullOr (submodule {
options = {
lower = mkOption {
description = lib.mdDoc "Lower limit of the reboot window";
description = "Lower limit of the reboot window";
type = types.strMatching "[[:digit:]]{2}:[[:digit:]]{2}";
example = "01:00";
};
upper = mkOption {
description = lib.mdDoc "Upper limit of the reboot window";
description = "Upper limit of the reboot window";
type = types.strMatching "[[:digit:]]{2}:[[:digit:]]{2}";
example = "05:00";
};
@ -150,7 +150,7 @@ in {
default = true;
type = types.bool;
example = false;
description = lib.mdDoc ''
description = ''
Takes a boolean argument. If true, the time when the service
unit was last triggered is stored on disk. When the timer is
activated, the service unit is triggered immediately if it