mirror of
https://github.com/NixOS/nix.git
synced 2024-11-22 06:42:28 +00:00
22b278e011
This is done in roughly the same way builtin functions are documented. Also auto-link experimental features for primops, subsuming PR #8371. Co-authored-by: Eelco Dolstra <edolstra@gmail.com> Co-authored-by: Robert Hensing <roberth@users.noreply.github.com> Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
29 lines
857 B
Nix
29 lines
857 B
Nix
let
|
|
inherit (builtins) concatStringsSep attrValues mapAttrs;
|
|
inherit (import ./utils.nix) optionalString squash;
|
|
in
|
|
|
|
builtinsInfo:
|
|
let
|
|
showBuiltin = name: { doc, args, arity, experimental-feature }:
|
|
let
|
|
experimentalNotice = optionalString (experimental-feature != null) ''
|
|
This function is only available if the [${experimental-feature}](@docroot@/contributing/experimental-features.md#xp-feature-${experimental-feature}) experimental feature is enabled.
|
|
'';
|
|
in
|
|
squash ''
|
|
<dt id="builtins-${name}">
|
|
<a href="#builtins-${name}"><code>${name} ${listArgs args}</code></a>
|
|
</dt>
|
|
<dd>
|
|
|
|
${doc}
|
|
|
|
${experimentalNotice}
|
|
|
|
</dd>
|
|
'';
|
|
listArgs = args: concatStringsSep " " (map (s: "<var>${s}</var>") args);
|
|
in
|
|
concatStringsSep "\n" (attrValues (mapAttrs showBuiltin builtinsInfo))
|