summary refs log tree commit diff
path: root/nixos/modules/config
diff options
context:
space:
mode:
authorRobert Hensing <roberth@users.noreply.github.com>2022-06-21 13:16:02 +0200
committerGitHub <noreply@github.com>2022-06-21 13:16:02 +0200
commite2c261f2c00464ef7cbb4d7ee7d274215160cd9c (patch)
tree90226cbe2c9a235e10be717433ee0891dbfd05ce /nixos/modules/config
parenta72d7811be1162dd6804c4e36e5402d76fb6e921 (diff)
parent320aa2a7910a71371204d672ff612cc9af5337da (diff)
downloadnixpkgs-e2c261f2c00464ef7cbb4d7ee7d274215160cd9c.tar
nixpkgs-e2c261f2c00464ef7cbb4d7ee7d274215160cd9c.tar.gz
nixpkgs-e2c261f2c00464ef7cbb4d7ee7d274215160cd9c.tar.bz2
nixpkgs-e2c261f2c00464ef7cbb4d7ee7d274215160cd9c.tar.lz
nixpkgs-e2c261f2c00464ef7cbb4d7ee7d274215160cd9c.tar.xz
nixpkgs-e2c261f2c00464ef7cbb4d7ee7d274215160cd9c.tar.zst
nixpkgs-e2c261f2c00464ef7cbb4d7ee7d274215160cd9c.zip
Merge pull request #176146 from pennae/module-docs-markdown
treewide: markdown option docs
Diffstat (limited to 'nixos/modules/config')
-rw-r--r--nixos/modules/config/console.nix4
-rw-r--r--nixos/modules/config/debug-info.nix19
2 files changed, 11 insertions, 12 deletions
diff --git a/nixos/modules/config/console.nix b/nixos/modules/config/console.nix
index b60fc55851d..97e6405db91 100644
--- a/nixos/modules/config/console.nix
+++ b/nixos/modules/config/console.nix
@@ -46,9 +46,9 @@ in
       type = with types; either str path;
       default = "Lat2-Terminus16";
       example = "LatArCyrHeb-16";
-      description = ''
+      description = mdDoc ''
         The font used for the virtual consoles.  Leave empty to use
-        whatever the <command>setfont</command> program considers the
+        whatever the {command}`setfont` program considers the
         default font.
         Can be either a font name or a path to a PSF font file.
       '';
diff --git a/nixos/modules/config/debug-info.nix b/nixos/modules/config/debug-info.nix
index 2942ae5905d..78de26fda44 100644
--- a/nixos/modules/config/debug-info.nix
+++ b/nixos/modules/config/debug-info.nix
@@ -9,21 +9,20 @@ with lib;
     environment.enableDebugInfo = mkOption {
       type = types.bool;
       default = false;
-      description = ''
+      description = mdDoc ''
         Some NixOS packages provide debug symbols. However, these are
         not included in the system closure by default to save disk
         space. Enabling this option causes the debug symbols to appear
-        in <filename>/run/current-system/sw/lib/debug/.build-id</filename>,
-        where tools such as <command>gdb</command> can find them.
+        in {file}`/run/current-system/sw/lib/debug/.build-id`,
+        where tools such as {command}`gdb` can find them.
         If you need debug symbols for a package that doesn't
         provide them by default, you can enable them as follows:
-        <programlisting>
-        nixpkgs.config.packageOverrides = pkgs: {
-          hello = pkgs.hello.overrideAttrs (oldAttrs: {
-            separateDebugInfo = true;
-          });
-        };
-        </programlisting>
+
+            nixpkgs.config.packageOverrides = pkgs: {
+              hello = pkgs.hello.overrideAttrs (oldAttrs: {
+                separateDebugInfo = true;
+              });
+            };
       '';
     };