nathan/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2026-08-26 02:05:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

utils.mkStateRevisionOption: replace table with ol

Browse Source 
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.
This commit is contained in:
Ryan Hendrickson
2026-08-09 00:44:51 -04:00
parent 7532d3bfc2
commit 1e7ede313f
1 changed files with 5 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
nixos/lib/utils.nix
View File

@@ -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`