[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

19/28: doc: Update the documentation for the asdf build systems.

From: Ricardo Wurmus
Subject: 19/28: doc: Update the documentation for the asdf build systems.
Date: Tue, 16 May 2017 09:24:36 -0400 (EDT)

rekado pushed a commit to branch master
in repository guix.

commit 8a3814cdc5be79f4308ce20d8351d5bcc9536ee2
Author: Andy Patterson <address@hidden>
Date:   Sat Apr 8 23:43:33 2017 -0400

    doc: Update the documentation for the asdf build systems.
    * doc/guix.texi (Build Systems): Remove the no-longer relevant parts about
    naming inputs.  Add documentation for the new parameters #:asd-system-name 
 doc/guix.texi | 30 ++++++++++++------------------
 1 file changed, 12 insertions(+), 18 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 7baf6ee..b272fce 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -3358,23 +3358,8 @@ These build systems can also be used to produce 
executable programs, or
 lisp images which contain a set of packages pre-loaded.
 The build system uses naming conventions.  For binary packages, the
-package itself as well as its run-time dependencies should begin their
-name with the lisp implementation, such as @code{sbcl-} for
address@hidden/sbcl}.  Beginning the input name with this
-prefix will allow the build system to encode its location into the
-resulting library, so that the input can be found at run-time.
-If dependencies are used only for tests, it is convenient to use a
-different prefix in order to avoid having a run-time dependency on such
-systems.  For example,
-(define-public sbcl-bordeaux-threads
-  (package
-    ...
-    (native-inputs `(("tests:cl-fiveam" ,sbcl-fiveam)))
-    ...))
address@hidden example
+package name should be prefixed with the lisp implementation, such as
address@hidden for @code{asdf-build-system/sbcl}.
 Additionally, the corresponding source package should be labeled using
 the same convention as python packages (see @ref{Python Modules}), using
@@ -3394,7 +3379,16 @@ expressions to be passed as the @code{#:entry-program} 
 If the system is not defined within its own @code{.asd} file of the same
 name, then the @code{#:asd-file} parameter should be used to specify
-which file the system is defined in.
+which file the system is defined in.  Furthermore, if the package
+defines a system for its tests in a separate file, it will be loaded
+before the tests are run if it is specified by the
address@hidden:test-asd-file} parameter.  If it is not set, the files
address@hidden<system>-tests.asd}, @code{<system>-test.asd}, @code{tests.asd},
+and @code{test.asd} will be tried if they exist.
+If for some reason the package must be named in a different way than the
+naming conventions suggest, the @code{#:asd-system-name} parameter can
+be used to specify the name of the system.
 @end defvr

reply via email to

[Prev in Thread] Current Thread [Next in Thread]