diff mbox series

[bug#66500,core-updates,1/3] build: copy-build-system: Allow specifying different output labels.

Message ID b486734d4ac6f5247d216da3444d91acb7e2ebd1.1697124046.git.mirai@makinata.eu
State New
Headers show
Series Custom output labels for copy-build-system. | expand

Commit Message

Bruno Victal Oct. 12, 2023, 3:30 p.m. UTC
* guix/build/copy-build-system.scm: Introduce '#:output' parameter to specify
which output label to use for a given rule.
* doc/guix.texi (Build Systems): Document it.
---
 doc/guix.texi                    |  6 ++++++
 guix/build/copy-build-system.scm | 18 +++++++++++++-----
 2 files changed, 19 insertions(+), 5 deletions(-)

Comments

Liliana Marie Prikler Oct. 19, 2023, 9:46 a.m. UTC | #1
Hi Bruno,

Am Donnerstag, dem 12.10.2023 um 16:30 +0100 schrieb Bruno Victal:
> [...]
> +@item When a package has multiple outputs the @code{#:output}
> argument
> +can be used to specify which output label the files should be
> installed
> +to.
This is perhaps extremely nitpicky, but there should be a comma before
"the @code{#:output} argument".

> @@ -63,6 +64,9 @@ (define* (install #:key install-plan outputs
> #:allow-other-keys)
>        If both `#:include*` and `#:exclude*` are specified, the
> exclusion is done
>        on the inclusion list.
>  
> +- When a package has multiple outputs the `#:output` argument can be
> used
> +to specify which output label the files should be installed to.
> +
Same here.
>  Examples:
>  
>  - `(\"foo/bar\" \"share/my-app/\")`: Install bar to \"share/my-
> app/bar\".
> @@ -72,7 +76,9 @@ (define* (install #:key install-plan outputs
> #:allow-other-keys)
>  - `(\"foo/\" \"share/my-app\" #:include (\"sub/file\"))`: Install
> only \"foo/sub/file\" to
>  \"share/my-app/sub/file\".
>  - `(\"foo/sub\" \"share/my-app\" #:include (\"file\"))`: Install
> \"foo/sub/file\" to
> -\"share/my-app/file\"."
> +\"share/my-app/file\".
> +- `(\"foo/doc\" \"share/my-app/doc\" #:output \"doc\")`: Install
> \"foo/doc\" to
> +\"share/my-app/doc\" for output labelled \"doc\"."
s/for output labelled/within the output named/
or 
s/for output labelled \"doc\"/within the \"doc\" output/

>    (define (install-simple source target)
>      "Install SOURCE to TARGET.
>  TARGET must point to a store location.
> @@ -133,8 +139,10 @@ (define* (install #:key install-plan outputs
> #:allow-other-keys)
>                                        (string-append target "/")))
>               file-list))))
>  
> -  (define* (install source target #:key include exclude include-
> regexp exclude-regexp)
> -    (let ((final-target (string-append (assoc-ref outputs "out") "/"
> target))
> +  (define* (install source target
> +                    #:key include exclude include-regexp exclude-
> regexp
> +                    (output "out"))
> +    (let ((final-target (string-append (assoc-ref outputs output)
> "/" target))
>            (filters? (or include exclude include-regexp exclude-
> regexp)))
>        (when (and (not (file-is-directory? source))
>                   filters?)
Otherwise LGTM.  Note, however, that CI doesn't like this series.

Cheers
Bruno Victal Oct. 19, 2023, 3:36 p.m. UTC | #2
Hi Liliana,

On 2023-10-19 10:46, Liliana Marie Prikler wrote:
> This is perhaps extremely nitpicky, but there should be a comma before
> "the @code{#:output} argument".

Addressing this with v2.

> s/for output labelled/within the output named/
> or 
> s/for output labelled \"doc\"/within the \"doc\" output/

Likewise, went for the second choice here.

> Otherwise LGTM.  Note, however, that CI doesn't like this series.

Strange, the CI complains of a merge conflict yet I didn't encounter
any issues when rebasing this to the latest core-updates [1].


[1]: guix commit d59653b7c9e43ebdbba20e2ca071429507f94c67
diff mbox series

Patch

diff --git a/doc/guix.texi b/doc/guix.texi
index 4afe1af6c0..8e627912a0 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -9460,6 +9460,9 @@  Build Systems
 If both inclusions and exclusions are specified, the exclusions are done
 on top of the inclusions.
 @end itemize
+@item When a package has multiple outputs the @code{#:output} argument
+can be used to specify which output label the files should be installed
+to.
 @end itemize
 In all cases, the paths relative to @var{source} are preserved within
 @var{target}.
@@ -9476,6 +9479,9 @@  Build Systems
 @file{share/my-app/sub/file}.
 @item @code{("foo/sub" "share/my-app" #:include ("file"))}: Install @file{foo/sub/file} to
 @file{share/my-app/file}.
+@item @code{("foo/doc" "share/my-app/doc" #:output "doc")}: Install
+@file{"foo/doc"} to @file{"share/my-app/doc"} for output labelled
+@code{"doc"}.
 @end itemize
 @end defvar
 
diff --git a/guix/build/copy-build-system.scm b/guix/build/copy-build-system.scm
index fb2d1db056..152cf88224 100644
--- a/guix/build/copy-build-system.scm
+++ b/guix/build/copy-build-system.scm
@@ -2,6 +2,7 @@ 
 ;;; Copyright © 2019 Julien Lepiller <julien@lepiller.eu>
 ;;; Copyright © 2020 Pierre Neidhardt <mail@ambrevar.xyz>
 ;;; Copyright © 2021 Efraim Flashner <efraim@flashner.co.il>
+;;; Copyright © 2023 Bruno Victal <mirai@makinata.eu>
 ;;;
 ;;; This file is part of GNU Guix.
 ;;;
@@ -40,9 +41,9 @@  (define* (install #:key install-plan outputs #:allow-other-keys)
 
 An install plan is a list of plans in the form:
 
-  (SOURCE TARGET [FILTERS])
+  (SOURCE TARGET [FILTERS] [#:output OUTPUT])
 
-In the above, FILTERS are optional.
+In the above, FILTERS and OUTPUT are optional.
 
 - When SOURCE matches a file or directory without trailing slash, install it to
   TARGET.
@@ -63,6 +64,9 @@  (define* (install #:key install-plan outputs #:allow-other-keys)
       If both `#:include*` and `#:exclude*` are specified, the exclusion is done
       on the inclusion list.
 
+- When a package has multiple outputs the `#:output` argument can be used
+to specify which output label the files should be installed to.
+
 Examples:
 
 - `(\"foo/bar\" \"share/my-app/\")`: Install bar to \"share/my-app/bar\".
@@ -72,7 +76,9 @@  (define* (install #:key install-plan outputs #:allow-other-keys)
 - `(\"foo/\" \"share/my-app\" #:include (\"sub/file\"))`: Install only \"foo/sub/file\" to
 \"share/my-app/sub/file\".
 - `(\"foo/sub\" \"share/my-app\" #:include (\"file\"))`: Install \"foo/sub/file\" to
-\"share/my-app/file\"."
+\"share/my-app/file\".
+- `(\"foo/doc\" \"share/my-app/doc\" #:output \"doc\")`: Install \"foo/doc\" to
+\"share/my-app/doc\" for output labelled \"doc\"."
   (define (install-simple source target)
     "Install SOURCE to TARGET.
 TARGET must point to a store location.
@@ -133,8 +139,10 @@  (define* (install #:key install-plan outputs #:allow-other-keys)
                                       (string-append target "/")))
              file-list))))
 
-  (define* (install source target #:key include exclude include-regexp exclude-regexp)
-    (let ((final-target (string-append (assoc-ref outputs "out") "/" target))
+  (define* (install source target
+                    #:key include exclude include-regexp exclude-regexp
+                    (output "out"))
+    (let ((final-target (string-append (assoc-ref outputs output) "/" target))
           (filters? (or include exclude include-regexp exclude-regexp)))
       (when (and (not (file-is-directory? source))
                  filters?)