about summary refs log tree commit diff
path: root/lib/systems
diff options
context:
space:
mode:
authorJohannes Kirschbauer <hsjobeki+github@gmail.com>2024-04-04 16:36:07 +0200
committerGitHub <noreply@github.com>2024-04-04 16:36:07 +0200
commitc0f5f271d1cbc469d47306ef58f67241f8654e12 (patch)
treeebd54a1f285ba150b1516fbc43d30fac6d92ea05 /lib/systems
parent52257144db727c6b999ec01293ab83bf41cdbbda (diff)
doc: migrate trivial files to doc-comment format (#299986)
* doc: migrate trivial files to doc-comment format

* fix: revert some comments

* Apply suggestions from code review

Thanks @danielSidhion

Co-authored-by: Daniel Sidhion <DanielSidhion@users.noreply.github.com>

* Update lib/types.nix

---------

Co-authored-by: Daniel Sidhion <DanielSidhion@users.noreply.github.com>
Co-authored-by: Silvan Mosberger <github@infinisil.com>
Diffstat (limited to 'lib/systems')
-rw-r--r--lib/systems/default.nix11
1 files changed, 7 insertions, 4 deletions
diff --git a/lib/systems/default.nix b/lib/systems/default.nix
index 83ed32ed3275b..7e9aadeef72e5 100644
--- a/lib/systems/default.nix
+++ b/lib/systems/default.nix
@@ -27,7 +27,7 @@ let
   examples = import ./examples.nix { inherit lib; };
   architectures = import ./architectures.nix { inherit lib; };
 
-  /*
+  /**
     Elaborated systems contain functions, which means that they don't satisfy
     `==` for a lack of reflexivity.
 
@@ -45,10 +45,13 @@ let
     let removeFunctions = a: filterAttrs (_: v: !isFunction v) a;
     in a: b: removeFunctions a == removeFunctions b;
 
-  /* List of all Nix system doubles the nixpkgs flake will expose the package set
-     for. All systems listed here must be supported by nixpkgs as `localSystem`.
+  /**
+    List of all Nix system doubles the nixpkgs flake will expose the package set
+    for. All systems listed here must be supported by nixpkgs as `localSystem`.
 
-     **Warning**: This attribute is considered experimental and is subject to change.
+    :::{.warning}
+    This attribute is considered experimental and is subject to change.
+    :::
   */
   flakeExposed = import ./flake-systems.nix { };