Changeset 39528 in project

Timestamp:

01/25/21 04:38:26 (5 weeks ago)

Author:

evhan

Message:

wiki/beaker: Update Nix helper docs

File:

• wiki/eggref/5/beaker (modified) (4 diffs)

wiki/eggref/5/beaker

@@ -71 +71 @@
  $ chicken-lock r7rs > r7rs.lock
  ... time passes...
- $ chicken-install -override r7rs.lock r7rs
+ $ chicken-install -from-list r7rs.lock
 
 If no egg names are given on the command line, this program will look for
@@ -198 +198 @@
 == Nix Helpers
 
+This project also includes some helper functions for the [[https://nixos.org/|Nix]]
+package manager that make it easy to build CHICKEN programs.
+
 === Usage
 
-This library's Nix helpers can be imported from the Git repository archive:
+The helpers can be imported directly from the Git repository archive:
 
  let
    beaker = import (fetchTarball https://git.sr.ht/~evhan/beaker/archive/master.tar.gz) {};
  in
-   doStuff { ... }
-
-The project's {{default.nix}} only includes two helpers so it's also relatively
-harmless to pull into scope, for example:
-
- with import (fetchTarball https://git.sr.ht/~evhan/beaker/archive/6bfb584b.tar.gz) {};
+   doStuff { with beaker; ... }
+
+This library only includes two attributes, so it's also relatively harmless to
+pull into scope, for example:
+
+ with import (fetchTarball https://git.sr.ht/~evhan/beaker/archive/3679375a.tar.gz) {};
  
  eggProgram {
@@ -216 +219 @@
    src = ./.;
    eggCache = eggCache {
-     overrideFile = ./example.egg.lock;
+     eggs = ./example.egg.lock;
      hash = "sha256:00x5k7rhs1fy7fj5kma1yp2ikzbq98bfm33si5y8z8m25chb45sg";
    };
@@ -227 +230 @@
 A fixed-output derivation that fetches a set of eggs for installation.
 
-The list of eggs to cache should be specified via {{overrideFile}}, which
-expects a path to a file in "override" specifying a list of egg names and
-versions. This file can be generated via {{chicken-status -list}} (for installed
-eggs) or {{chicken-lock}} (for a specific egg's dependencies).
+The list of eggs to cache should be specified via {{eggs}}, which expects a path
+to a file in "override" specifying a list of egg names and versions. This file
+can be generated via {{chicken-status -list}} (for installed eggs) or
+{{chicken-lock}} (for a specific egg's dependencies).
 
  eggCache {
-   name = "example-egg-cache"
-   overrideFile = ./eggs.lock
-   hash = "sha256:03pz5927dkazrf8hf53w03r80ca98fwp09gmd8iiywxc5vl8ll2m"
- }
+   name = "example-egg-cache";
+   hash = "sha256:03pz5927dkazrf8hf53w03r80ca98fwp09gmd8iiywxc5vl8ll2m";
+   eggs = ./eggs.lock;
+ }
+
+Alternatively, you can specify the list of eggs directly:
+
+ eggCache {
+   name = "example-egg-cache";
+   hash = "sha256:01fq1398aj4r54yw6ym8i56i236yb3pvmn6a54iahz09cp615g2x";
+   eggs = [
+     { name = "srfi-18"; version = "0.1"; }
+     { name = "srfi-69"; version = "0.4"; }
+   ];
+ }
+
+==== Combining Multiple Egg Caches
+
+To merge multiple egg caches, you can use {{symlinkJoin}}:
+
+ pkgs.symlinkJoin {
+   name = "example-egg-caches";
+   paths = [
+     (eggCache { ... })
+     (eggCache { ... })
+   ];
+ }
+
+The result will be a single egg cache containing all of the specified eggs.
+Note that if any input paths contain different versions of the same egg, the
+first one listed takes precedence.
 
 === Building Eggs