summaryrefslogtreecommitdiff
path: root/guix/import
diff options
context:
space:
mode:
authorTobias Geerinckx-Rice <me@tobias.gr>2021-06-21 14:44:47 +0200
committerTobias Geerinckx-Rice <me@tobias.gr>2021-06-21 18:27:19 +0200
commitfe255fb8bc87125524207db6115d25a0417a99d5 (patch)
tree09fb71a11bf12f5e80b59af1900d56f2cbfd4c5a /guix/import
parent885d05acb9339f860f03efe41b44b8cf4fe9d987 (diff)
import: egg: Edit egg->guix-package docstring.
* guix/import/egg.scm (egg->guix-package): Edit docstring.
Diffstat (limited to 'guix/import')
-rw-r--r--guix/import/egg.scm12
1 files changed, 8 insertions, 4 deletions
diff --git a/guix/import/egg.scm b/guix/import/egg.scm
index 26f8364732..107894ddcf 100644
--- a/guix/import/egg.scm
+++ b/guix/import/egg.scm
@@ -1,5 +1,6 @@
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2021 Xinglu Chen <public@yoctocell.xyz>
+;;; Copyright © 2021 Tobias Geerinckx-Rice <me@tobias.gr>
;;;
;;; This file is part of GNU Guix.
;;;
@@ -173,10 +174,13 @@ return the package metadata in FILE."
;;;
(define* (egg->guix-package name #:key (file #f) (source #f))
- "Import CHICKEN egg NAME from and return a <package> record type for the
-egg, or #f on failure. FILE is the filepath to the NAME.egg file. SOURCE is
-the a ``file-like'' object containing the source code corresonding to the egg.
-If SOURCE is not specified, the tarball for the egg will be downloaded.
+ "Import a CHICKEN egg called NAME from either the given .egg FILE, or from
+the latest NAME metadata downloaded from the official repository if FILE is #f.
+Return a <package> record or #f on failure.
+
+SOURCE is a ``file-like'' object containing the source code corresponding to
+the egg. If SOURCE is not specified, the latest tarball for egg NAME will be
+downloaded.
Specifying the SOURCE argument is mainly useful for developing a CHICKEN egg
locally. Note that if FILE and SOURCE are specified, recursive import will