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-03 22:46:41 +0200
committerpennae <github@quasiparticle.net>2022-08-03 22:46:41 +0200
commit61e93df1891972bae3e0c97a477bd44e8a477aa0 (patch)
tree4285c1d22db537fb02baf1e978eb4434b0276b0c /nixos/modules/virtualisation/nixos-containers.nix
parent645cfa59ac5690187eac40ef2ac67381668acecc (diff)
downloadnixpkgs-61e93df1891972bae3e0c97a477bd44e8a477aa0.tar
nixpkgs-61e93df1891972bae3e0c97a477bd44e8a477aa0.tar.gz
nixpkgs-61e93df1891972bae3e0c97a477bd44e8a477aa0.tar.bz2
nixpkgs-61e93df1891972bae3e0c97a477bd44e8a477aa0.tar.lz
nixpkgs-61e93df1891972bae3e0c97a477bd44e8a477aa0.tar.xz
nixpkgs-61e93df1891972bae3e0c97a477bd44e8a477aa0.tar.zst
nixpkgs-61e93df1891972bae3e0c97a477bd44e8a477aa0.zip
nixos/*: automatically convert option docs to MD
once again using nix-doc-munge (https://github.com/pennae/nix-doc-munge/commit/69d080323ae27c0d8da3967c62b925a9aedb2828)
Diffstat (limited to 'nixos/modules/virtualisation/nixos-containers.nix')
-rw-r--r--nixos/modules/virtualisation/nixos-containers.nix12
1 files changed, 6 insertions, 6 deletions
diff --git a/nixos/modules/virtualisation/nixos-containers.nix b/nixos/modules/virtualisation/nixos-containers.nix
index 1699b0bcea4..6b8c21336c6 100644
--- a/nixos/modules/virtualisation/nixos-containers.nix
+++ b/nixos/modules/virtualisation/nixos-containers.nix
@@ -579,11 +579,11 @@ in
             privateNetwork = mkOption {
               type = types.bool;
               default = false;
-              description = ''
+              description = lib.mdDoc ''
                 Whether to give the container its own private virtual
                 Ethernet interface.  The interface is called
-                <literal>eth0</literal>, and is hooked up to the interface
-                <literal>ve-«container-name»</literal>
+                `eth0`, and is hooked up to the interface
+                `ve-«container-name»`
                 on the host.  If this option is not set, then the
                 container shares the network interfaces of the host,
                 and can bind to any port on any interface.
@@ -728,12 +728,12 @@ in
               };
           }
         '';
-      description = ''
+      description = lib.mdDoc ''
         A set of NixOS system configurations to be run as lightweight
         containers.  Each container appears as a service
-        <literal>container-«name»</literal>
+        `container-«name»`
         on the host system, allowing it to be started and stopped via
-        <command>systemctl</command>.
+        {command}`systemctl`.
       '';
     };