From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:46346) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cx3lm-0000UN-4I for guix-patches@gnu.org; Sat, 08 Apr 2017 23:44:07 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1cx3lj-0002zw-KS for guix-patches@gnu.org; Sat, 08 Apr 2017 23:44:06 -0400 Received: from debbugs.gnu.org ([208.118.235.43]:40535) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1cx3lj-0002zb-GW for guix-patches@gnu.org; Sat, 08 Apr 2017 23:44:03 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1cx3lj-0005Ns-A9 for guix-patches@gnu.org; Sat, 08 Apr 2017 23:44:03 -0400 Subject: bug#26346: [PATCH 20/20] doc: Update the documentation for the asdf build systems. Resent-Message-ID: From: Andy Patterson Date: Sat, 8 Apr 2017 23:43:33 -0400 Message-Id: <20170409034333.3801-3-ajpatter@uwaterloo.ca> In-Reply-To: <20170409034333.3801-1-ajpatter@uwaterloo.ca> References: <20170403003732.1c3b8afb@uwaterloo.ca> <20170409034333.3801-1-ajpatter@uwaterloo.ca> List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+kyle=kyleam.com@gnu.org Sender: "Guix-patches" To: 26346@debbugs.gnu.org * 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 974d9b3a4..f3a4531a6 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -3346,23 +3346,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 -@code{asdf-build-system/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, - -@example -(define-public sbcl-bordeaux-threads - (package - ... - (native-inputs `(("tests:cl-fiveam" ,sbcl-fiveam))) - ...)) -@end example +package name should be prefixed with the lisp implementation, such as +@code{sbcl-} 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 @@ -3382,7 +3367,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 +@code{#:test-asd-file} parameter. If it is not set, the files +@code{-tests.asd}, @code{-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 -- 2.12.2