diff options
author | pennae <github@quasiparticle.net> | 2022-08-15 07:16:25 +0200 |
---|---|---|
committer | pennae <82953136+pennae@users.noreply.github.com> | 2022-08-19 22:40:58 +0200 |
commit | 6039648c50c7c0858b5e506c6298773a98e0f066 (patch) | |
tree | 5421b3c36609e710c85b43d92dc3b830f6a1385b /nixos/modules/tasks | |
parent | 7e7d68a250f75678451cd44f8c3d585bf750461e (diff) |
nixos/*: automatically convert option docs
Diffstat (limited to 'nixos/modules/tasks')
-rw-r--r-- | nixos/modules/tasks/auto-upgrade.nix | 4 | ||||
-rw-r--r-- | nixos/modules/tasks/filesystems.nix | 24 |
2 files changed, 14 insertions, 14 deletions
diff --git a/nixos/modules/tasks/auto-upgrade.nix b/nixos/modules/tasks/auto-upgrade.nix index 309790eb0ed82..29e3e313336f5 100644 --- a/nixos/modules/tasks/auto-upgrade.nix +++ b/nixos/modules/tasks/auto-upgrade.nix @@ -46,10 +46,10 @@ in { type = types.nullOr types.str; default = null; example = "https://nixos.org/channels/nixos-14.12-small"; - description = '' + description = lib.mdDoc '' The URI of the NixOS channel to use for automatic upgrades. By default, this is the channel set using - <command>nix-channel</command> (run <literal>nix-channel --list</literal> + {command}`nix-channel` (run `nix-channel --list` to see the current value). ''; }; diff --git a/nixos/modules/tasks/filesystems.nix b/nixos/modules/tasks/filesystems.nix index cf9429f76b4c7..2a17baf651678 100644 --- a/nixos/modules/tasks/filesystems.nix +++ b/nixos/modules/tasks/filesystems.nix @@ -175,20 +175,20 @@ in } ''; type = types.attrsOf (types.submodule [coreFileSystemOpts fileSystemOpts]); - description = '' + description = lib.mdDoc '' The file systems to be mounted. It must include an entry for - the root directory (<literal>mountPoint = "/"</literal>). Each + the root directory (`mountPoint = "/"`). Each entry in the list is an attribute set with the following fields: - <literal>mountPoint</literal>, <literal>device</literal>, - <literal>fsType</literal> (a file system type recognised by - <command>mount</command>; defaults to - <literal>"auto"</literal>), and <literal>options</literal> - (the mount options passed to <command>mount</command> using the - <option>-o</option> flag; defaults to <literal>[ "defaults" ]</literal>). - - Instead of specifying <literal>device</literal>, you can also - specify a volume label (<literal>label</literal>) for file - systems that support it, such as ext2/ext3 (see <command>mke2fs -L</command>). + `mountPoint`, `device`, + `fsType` (a file system type recognised by + {command}`mount`; defaults to + `"auto"`), and `options` + (the mount options passed to {command}`mount` using the + {option}`-o` flag; defaults to `[ "defaults" ]`). + + Instead of specifying `device`, you can also + specify a volume label (`label`) for file + systems that support it, such as ext2/ext3 (see {command}`mke2fs -L`). ''; }; |