From 1e7ede313f504bbce3d3ddcdcbda924ca7925121 Mon Sep 17 00:00:00 2001 From: Ryan Hendrickson Date: Sun, 9 Aug 2026 00:44:51 -0400 Subject: [PATCH] utils.mkStateRevisionOption: replace table with ol Use an ordered list in the description of options created by utils.mkStateRevisionOption instead of a table. The man page renderer (for `man configuration.nix`) does not support generating tables, even though the HTML renderer does. --- nixos/lib/utils.nix | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/nixos/lib/utils.nix b/nixos/lib/utils.nix index 964ca580ce1a..224d7ad90330 100644 --- a/nixos/lib/utils.nix +++ b/nixos/lib/utils.nix @@ -628,8 +628,9 @@ let will change) to Markdown instructions to users for manually migrating their data to this breakpoint. The migration instructions will be included in the NixOS documentation for this option. (These instructions - must only contain Markdown inlines, because they will be rendered in a - table. In particular, lists will not render correctly.) + must only contain Markdown inlines, because they will be rendered as + items in an ordered list. In particular, nested lists will not render + correctly.) `migrations` will also be exposed as an attribute on the result. @@ -706,11 +707,9 @@ let `stateRevision`, up to and including the row for the new `stateRevision`): - | `stateRevision` | Migration instructions | - |-----------------|------------------------| - | 0 | (none) | + 0. (none) ${concatImapStringsSep "\n" ( - v: sv: "| ${toString v} | ${replaceStrings [ "\n" ] [ " " ] migrations.${sv}} |" + v: sv: "${toString v}. ${replaceStrings [ "\n" ] [ " " ] migrations.${sv}}" ) versions} Note that you do **not** need to change {option}`system.stateVersion`