movefasta/nixpkgs
0
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-07-13 13:40:28 +03:00
Code Activity

treewide: automatically md-convert option descriptions

Browse source 
the conversion procedure is simple:

 - find all things that look like options, ie calls to either `mkOption`
   or `lib.mkOption` that take an attrset. remember the attrset as the
   option
 - for all options, find a `description` attribute who's value is not a
   call to `mdDoc` or `lib.mdDoc`
 - textually convert the entire value of the attribute to MD with a few
   simple regexes (the set from mdize-module.sh)
 - if the change produced a change in the manual output, discard
 - if the change kept the manual unchanged, add some text to the
   description to make sure we've actually found an option. if the
   manual changes this time, keep the converted description

this procedure converts 80% of nixos options to markdown. around 2000
options remain to be inspected, but most of those fail the "does not
change the manual output check": currently the MD conversion process
does not faithfully convert docbook tags like <code> and <package>, so
any option using such tags will not be converted at all.
This commit is contained in:
pennae 2022-07-28 23:19:15 +02:00
parent 52b0ad17e3
commit 2e751c0772
1050 changed files with 9605 additions and 9605 deletions
Download patch file Download diff file Expand all files Collapse all files

4
nixos/modules/tasks/filesystems/btrfs.nix
View file

@ -24,8 +24,8 @@ in
fileSystems = mkOption {
type = types.listOf types.path;
example = [ "/" ];
description = ''
List of paths to btrfs filesystems to regularily call <command>btrfs scrub</command> on.
description = lib.mdDoc ''
List of paths to btrfs filesystems to regularily call {command}`btrfs scrub` on.
Defaults to all mount points with btrfs filesystems.
If you mount a filesystem multiple times or additionally mount subvolumes,
you need to manually specify this list to avoid scrubbing multiple times.

6
nixos/modules/tasks/filesystems/nfs.nix
View file

@ -30,9 +30,9 @@ in
idmapd.settings = mkOption {
type = format.type;
default = {};
description = ''
description = lib.mdDoc ''
libnfsidmap configuration. Refer to
<link xlink:href="https://linux.die.net/man/5/idmapd.conf"/>
<https://linux.die.net/man/5/idmapd.conf>
for details.
'';
example = literalExpression ''
@ -49,7 +49,7 @@ in
extraConfig = mkOption {
type = types.lines;
default = "";
description = ''
description = lib.mdDoc ''
Extra nfs-utils configuration.
'';
};

54
nixos/modules/tasks/filesystems/zfs.nix
View file

@ -202,7 +202,7 @@ in
type = types.package;
default = if config.boot.zfs.enableUnstable then pkgs.zfsUnstable else pkgs.zfs;
defaultText = literalExpression "if config.boot.zfs.enableUnstable then pkgs.zfsUnstable else pkgs.zfs";
description = "Configured ZFS userland tools package.";
description = lib.mdDoc "Configured ZFS userland tools package.";
};
enabled = mkOption {
@ -210,13 +210,13 @@ in
type = types.bool;
default = inInitrd || inSystem;
defaultText = literalDocBook "<literal>true</literal> if ZFS filesystem support is enabled";
description = "True if ZFS filesystem support is enabled";
description = lib.mdDoc "True if ZFS filesystem support is enabled";
};
enableUnstable = mkOption {
type = types.bool;
default = false;
description = ''
description = lib.mdDoc ''
Use the unstable zfs package. This might be an option, if the latest
kernel is not yet supported by a published release of ZFS. Enabling
this option will install a development version of ZFS on Linux. The
@ -230,12 +230,12 @@ in
type = types.listOf types.str;
default = [];
example = [ "tank" "data" ];
description = ''
description = lib.mdDoc ''
Name or GUID of extra ZFS pools that you wish to import during boot.
Usually this is not necessary. Instead, you should set the mountpoint property
of ZFS filesystems to <literal>legacy</literal> and add the ZFS filesystems to
NixOS's <option>fileSystems</option> option, which makes NixOS automatically
of ZFS filesystems to `legacy` and add the ZFS filesystems to
NixOS's {option}`fileSystems` option, which makes NixOS automatically
import the associated pool.
However, in some cases (e.g. if you have many filesystems) it may be preferable
@ -248,7 +248,7 @@ in
devNodes = mkOption {
type = types.path;
default = "/dev/disk/by-id";
description = ''
description = lib.mdDoc ''
Name of directory from which to import ZFS devices.
This should be a path under /dev containing stable names for all devices needed, as
@ -259,16 +259,16 @@ in
forceImportRoot = mkOption {
type = types.bool;
default = true;
description = ''
description = lib.mdDoc ''
Forcibly import the ZFS root pool(s) during early boot.
This is enabled by default for backwards compatibility purposes, but it is highly
recommended to disable this option, as it bypasses some of the safeguards ZFS uses
to protect your ZFS pools.
If you set this option to <literal>false</literal> and NixOS subsequently fails to
If you set this option to `false` and NixOS subsequently fails to
boot because it cannot import the root pool, you should boot with the
<literal>zfs_force=1</literal> option as a kernel parameter (e.g. by manually
`zfs_force=1` option as a kernel parameter (e.g. by manually
editing the kernel params in grub during boot). You should only need to do this
once.
'';
@ -291,7 +291,7 @@ in
type = types.either types.bool (types.listOf types.str);
default = true;
example = [ "tank" "data" ];
description = ''
description = lib.mdDoc ''
If true on import encryption keys or passwords for all encrypted datasets
are requested. To only decrypt selected datasets supply a list of dataset
names instead. For root pools the encryption key can be supplied via both
@ -304,15 +304,15 @@ in
enable = mkOption {
default = false;
type = types.bool;
description = ''
description = lib.mdDoc ''
Enable the (OpenSolaris-compatible) ZFS auto-snapshotting service.
Note that you must set the <literal>com.sun:auto-snapshot</literal>
property to <literal>true</literal> on all datasets which you wish
Note that you must set the `com.sun:auto-snapshot`
property to `true` on all datasets which you wish
to auto-snapshot.
You can override a child dataset to use, or not use auto-snapshotting
by setting its flag with the given interval:
<literal>zfs set com.sun:auto-snapshot:weekly=false DATASET</literal>
`zfs set com.sun:auto-snapshot:weekly=false DATASET`
'';
};
@ -320,14 +320,14 @@ in
default = "-k -p";
example = "-k -p --utc";
type = types.str;
description = ''
description = lib.mdDoc ''
Flags to pass to the zfs-auto-snapshot command.
Run <literal>zfs-auto-snapshot</literal> (without any arguments) to
Run `zfs-auto-snapshot` (without any arguments) to
see available flags.
If it's not too inconvenient for snapshots to have timestamps in UTC,
it is suggested that you append <literal>--utc</literal> to the list
it is suggested that you append `--utc` to the list
of default options (see example).
Otherwise, snapshot names can cause name conflicts or apparent time
@ -338,7 +338,7 @@ in
frequent = mkOption {
default = 4;
type = types.int;
description = ''
description = lib.mdDoc ''
Number of frequent (15-minute) auto-snapshots that you wish to keep.
'';
};
@ -346,7 +346,7 @@ in
hourly = mkOption {
default = 24;
type = types.int;
description = ''
description = lib.mdDoc ''
Number of hourly auto-snapshots that you wish to keep.
'';
};
@ -354,7 +354,7 @@ in
daily = mkOption {
default = 7;
type = types.int;
description = ''
description = lib.mdDoc ''
Number of daily auto-snapshots that you wish to keep.
'';
};
@ -362,7 +362,7 @@ in
weekly = mkOption {
default = 4;
type = types.int;
description = ''
description = lib.mdDoc ''
Number of weekly auto-snapshots that you wish to keep.
'';
};
@ -370,7 +370,7 @@ in
monthly = mkOption {
default = 12;
type = types.int;
description = ''
description = lib.mdDoc ''
Number of monthly auto-snapshots that you wish to keep.
'';
};
@ -378,7 +378,7 @@ in
services.zfs.trim = {
enable = mkOption {
description = "Whether to enable periodic TRIM on all ZFS pools.";
description = lib.mdDoc "Whether to enable periodic TRIM on all ZFS pools.";
default = true;
example = false;
type = types.bool;
@ -417,7 +417,7 @@ in
default = [];
type = types.listOf types.str;
example = [ "tank" ];
description = ''
description = lib.mdDoc ''
List of ZFS pools to periodically scrub. If empty, all pools
will be scrubbed.
'';
@ -464,11 +464,11 @@ in
ZED_SCRUB_AFTER_RESILVER = false;
}
'';
description = ''
description = lib.mdDoc ''
ZFS Event Daemon /etc/zfs/zed.d/zed.rc content
See
<citerefentry><refentrytitle>zed</refentrytitle><manvolnum>8</manvolnum></citerefentry>
{manpage}`zed(8)`
for details on ZED and the scripts in /etc/zfs/zed.d to find the possible variables
'';
};