about summary refs log tree commit diff
path: root/lib/meta.nix
diff options
context:
space:
mode:
authorRyan Mulligan <ryan@ryantm.com>2024-02-27 12:44:37 -0800
committerGitHub <noreply@github.com>2024-02-27 12:44:37 -0800
commit78d6e84385f5c77d17af504c440d5fc5aa89097b (patch)
treebc93d855897047bfb80b732ae64642f61f34a7ea /lib/meta.nix
parent87a9359410e8752bd4a927dc29acb1897652b4ab (diff)
parent3698be4ee605e664efa8fe9afe7ba9a8691b01b2 (diff)
Merge pull request #291909 from cdmistman/lib-meta-available-on-doc-example
lib.meta.availableOn: add example in documentation
Diffstat (limited to 'lib/meta.nix')
-rw-r--r--lib/meta.nix4
1 files changed, 4 insertions, 0 deletions
diff --git a/lib/meta.nix b/lib/meta.nix
index c8e67cbc70e28..675e1912d4be9 100644
--- a/lib/meta.nix
+++ b/lib/meta.nix
@@ -116,6 +116,10 @@ rec {
           platform, or `meta.platforms` is not present.
 
        2. None of `meta.badPlatforms` pattern matches the given platform.
+
+     Example:
+       lib.meta.availableOn { system = "aarch64-darwin"; } pkg.zsh
+       => true
   */
   availableOn = platform: pkg:
     ((!pkg?meta.platforms) || any (platformMatch platform) pkg.meta.platforms) &&