me/guix
Archived
1
0
Fork 0
Code Activity

import: egg: Edit egg->guix-package docstring.

Browse source 
* guix/import/egg.scm (egg->guix-package): Edit docstring.
This commit is contained in:
Tobias Geerinckx-Rice 2021-06-21 14:44:47 +02:00
parent 885d05acb9
commit fe255fb8bc
No known key found for this signature in database
GPG key ID: 0DB0FF884F556D79
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
guix/import/egg.scm
View file

@ -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