summary refs log tree commit diff
path: root/nixos/modules/virtualisation/nixos-containers.nix
diff options
context:
space:
mode:
authorpennae <github@quasiparticle.net>2022-08-15 07:16:25 +0200
committerpennae <82953136+pennae@users.noreply.github.com>2022-08-19 22:40:58 +0200
commit6039648c50c7c0858b5e506c6298773a98e0f066 (patch)
tree5421b3c36609e710c85b43d92dc3b830f6a1385b /nixos/modules/virtualisation/nixos-containers.nix
parent7e7d68a250f75678451cd44f8c3d585bf750461e (diff)
downloadnixpkgs-6039648c50c7c0858b5e506c6298773a98e0f066.tar
nixpkgs-6039648c50c7c0858b5e506c6298773a98e0f066.tar.gz
nixpkgs-6039648c50c7c0858b5e506c6298773a98e0f066.tar.bz2
nixpkgs-6039648c50c7c0858b5e506c6298773a98e0f066.tar.lz
nixpkgs-6039648c50c7c0858b5e506c6298773a98e0f066.tar.xz
nixpkgs-6039648c50c7c0858b5e506c6298773a98e0f066.tar.zst
nixpkgs-6039648c50c7c0858b5e506c6298773a98e0f066.zip
nixos/*: automatically convert option docs
Diffstat (limited to 'nixos/modules/virtualisation/nixos-containers.nix')
-rw-r--r--nixos/modules/virtualisation/nixos-containers.nix10
1 files changed, 5 insertions, 5 deletions
diff --git a/nixos/modules/virtualisation/nixos-containers.nix b/nixos/modules/virtualisation/nixos-containers.nix
index 1285563c646..f15511f2df5 100644
--- a/nixos/modules/virtualisation/nixos-containers.nix
+++ b/nixos/modules/virtualisation/nixos-containers.nix
@@ -536,13 +536,13 @@ in
               type = types.path;
               default = pkgs.path;
               defaultText = literalExpression "pkgs.path";
-              description = ''
+              description = lib.mdDoc ''
                 A path to the nixpkgs that provide the modules, pkgs and lib for evaluating the container.
 
-                To only change the <literal>pkgs</literal> argument used inside the container modules,
-                set the <literal>nixpkgs.*</literal> options in the container <option>config</option>.
-                Setting <literal>config.nixpkgs.pkgs = pkgs</literal> speeds up the container evaluation
-                by reusing the system pkgs, but the <literal>nixpkgs.config</literal> option in the
+                To only change the `pkgs` argument used inside the container modules,
+                set the `nixpkgs.*` options in the container {option}`config`.
+                Setting `config.nixpkgs.pkgs = pkgs` speeds up the container evaluation
+                by reusing the system pkgs, but the `nixpkgs.config` option in the
                 container config is ignored in this case.
               '';
             };