[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
and
#:test-asd-file.
---
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,
-
address@hidden
-(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}
argument.
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
- 18/28: build-system/asdf: Handle tests defined in external systems., (continued)
- 18/28: build-system/asdf: Handle tests defined in external systems., Ricardo Wurmus, 2017/05/16
- 14/28: gnu: Add cl-unicode., Ricardo Wurmus, 2017/05/16
- 06/28: build-system/asdf: Use asdf to determine dependencies., Ricardo Wurmus, 2017/05/16
- 05/28: gnu: cl-stumpwm: Build the library in "lib" and the program in "bin"., Ricardo Wurmus, 2017/05/16
- 11/28: build-system/asdf: Pass the system name as an argument to the builder., Ricardo Wurmus, 2017/05/16
- 23/28: gnu: java-stringtemplate-3: Use return value in build phase., Ricardo Wurmus, 2017/05/16
- 12/28: build-system/asdf: Always pre-load the system's definition file., Ricardo Wurmus, 2017/05/16
- 09/28: build-system/asdf: Make #:lisp a package argument., Ricardo Wurmus, 2017/05/16
- 26/28: gnu: Rename stringtemplate4 to java-stringtemplate., Ricardo Wurmus, 2017/05/16
- 13/28: build-system/asdf: Handle unusually-named systems., Ricardo Wurmus, 2017/05/16
- 19/28: doc: Update the documentation for the asdf build systems.,
Ricardo Wurmus <=
- 22/28: gnu: java-stringtemplate-3: Enable tests., Ricardo Wurmus, 2017/05/16
- 15/28: build-system/asdf: Simplify the use of lisp-eval-program., Ricardo Wurmus, 2017/05/16
- 27/28: gnu: Rename stringtemplate4-4.0.6 to java-stringtemplate-4.0.6., Ricardo Wurmus, 2017/05/16
- 20/28: gnu: Rename stringtemplate3 to java-stringtemplate-3., Ricardo Wurmus, 2017/05/16
- 16/28: build-system/asdf: Retain references to source files for binary outputs., Ricardo Wurmus, 2017/05/16
- 10/28: build-system/asdf: Parameterize the lisp type and implementation globally., Ricardo Wurmus, 2017/05/16
- 24/28: gnu: stringtemplate4: Inherit from java-stringtemplate-3., Ricardo Wurmus, 2017/05/16
- 28/28: gnu: java-stringtemplate: Get closer to fixing tests., Ricardo Wurmus, 2017/05/16
- 07/28: build-system/asdf: Don't rename inputs., Ricardo Wurmus, 2017/05/16