GNU bug report logs - #62754
[PATCH] doc: Use G-Expressions for package definition example.

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 62754 in the body.
You can then email your comments to 62754 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Bruno Victal <mirai <at> makinata.eu>
To: guix-patches <at> gnu.org
Cc: Bruno Victal <mirai <at> makinata.eu>
Subject: [PATCH] doc: Use G-Expressions for package definition example.
Date: Mon, 10 Apr 2023 16:13:30 +0100

* doc/guix.texi (Build Phases): Use G-Expressions for example.
---
 doc/guix.texi | 29 +++++++++++++++++------------
 1 file changed, 17 insertions(+), 12 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index ed42488882..100ad93a3e 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -10131,21 +10131,26 @@ Build Phases
     ;; other fields omitted
     (build-system gnu-build-system)
     (arguments
-     '(#:phases (modify-phases %standard-phases
-                  (delete 'configure)
-                  (add-before 'build 'set-prefix-in-makefile
-                    (lambda* (#:key outputs #:allow-other-keys)
-                      ;; Modify the makefile so that its
-                      ;; 'PREFIX' variable points to "out".
-                      (let ((out (assoc-ref outputs "out")))
-                        (substitute* "Makefile"
-                          (("PREFIX =.*")
-                           (string-append "PREFIX = "
-                                          out "\n")))))))))))
+     (list
+      #:phases
+      #~(modify-phases %standard-phases
+          (delete 'configure)
+          (add-before 'build 'set-prefix-in-makefile
+            (lambda* (#:key inputs #:allow-other-keys)
+              ;; Modify the makefile so that its
+              ;; 'PREFIX' variable points to "out" and
+              ;; 'XMLLINT' points to the correct path.
+              (substitute* "Makefile"
+                (("PREFIX =.*")
+                 (string-append "PREFIX = " #$output "\n"))
+                (("XMLLINT =.*")
+                 (string-append "XMLLINT = "
+                                (search-input-file inputs "/bin/xmllint")
+                                "\n"))))))))))
 @end lisp
 
 The new phase that is inserted is written as an anonymous procedure,
-introduced with @code{lambda*}; it honors the @code{outputs} parameter
+introduced with @code{lambda*}; it honors the @code{inputs} parameter
 we have seen before.  @xref{Build Utilities}, for more about the helpers
 used by this phase, and for more examples of @code{modify-phases}.
 

base-commit: b78d6ceaa07be3c7582627cd28712b67102e521c
-- 
2.39.2

Message #8 received at 62754 <at> debbugs.gnu.org (full text, mbox):

From: Ivan Sokolov <ivan-p-sokolov <at> ya.ru>
To: Bruno Victal <mirai <at> makinata.eu>
Cc: 62754 <at> debbugs.gnu.org
Subject: Re: [bug#62754] [PATCH] doc: Use G-Expressions for package
 definition example.
Date: Mon, 10 Apr 2023 22:00:41 +0300

Bruno Victal <mirai <at> makinata.eu> writes:

> * doc/guix.texi (Build Phases): Use G-Expressions for example.
> ---
>  doc/guix.texi | 29 +++++++++++++++++------------
>  1 file changed, 17 insertions(+), 12 deletions(-)
>
> diff --git a/doc/guix.texi b/doc/guix.texi
> index ed42488882..100ad93a3e 100644
> --- a/doc/guix.texi
> +++ b/doc/guix.texi
> @@ -10131,21 +10131,26 @@ Build Phases
>      ;; other fields omitted
>      (build-system gnu-build-system)
>      (arguments
> -     '(#:phases (modify-phases %standard-phases
> -                  (delete 'configure)
> -                  (add-before 'build 'set-prefix-in-makefile
> -                    (lambda* (#:key outputs #:allow-other-keys)
> -                      ;; Modify the makefile so that its
> -                      ;; 'PREFIX' variable points to "out".
> -                      (let ((out (assoc-ref outputs "out")))
> -                        (substitute* "Makefile"
> -                          (("PREFIX =.*")
> -                           (string-append "PREFIX = "
> -                                          out "\n")))))))))))
> +     (list
> +      #:phases
> +      #~(modify-phases %standard-phases
> +          (delete 'configure)
> +          (add-before 'build 'set-prefix-in-makefile
> +            (lambda* (#:key inputs #:allow-other-keys)
> +              ;; Modify the makefile so that its
> +              ;; 'PREFIX' variable points to "out" and
> +              ;; 'XMLLINT' points to the correct path.
> +              (substitute* "Makefile"
> +                (("PREFIX =.*")
> +                 (string-append "PREFIX = " #$output "\n"))
> +                (("XMLLINT =.*")
> +                 (string-append "XMLLINT = "
> +                                (search-input-file inputs "/bin/xmllint")
> +                                "\n"))))))))))
>  @end lisp
>  
>  The new phase that is inserted is written as an anonymous procedure,
> -introduced with @code{lambda*}; it honors the @code{outputs} parameter
> +introduced with @code{lambda*}; it honors the @code{inputs} parameter
>  we have seen before.  @xref{Build Utilities}, for more about the helpers
>  used by this phase, and for more examples of @code{modify-phases}.
>  
>
> base-commit: b78d6ceaa07be3c7582627cd28712b67102e521c

inputs parameter has not previously appeared in the documentation, the
sentence before last does not make sense anymore.

Message #11 received at 62754 <at> debbugs.gnu.org (full text, mbox):

From: Bruno Victal <mirai <at> makinata.eu>
To: 62754 <at> debbugs.gnu.org
Cc: Bruno Victal <mirai <at> makinata.eu>, ivan-p-sokolov <at> ya.ru
Subject: [PATCH v2] doc: Use G-Expressions for package definition example.
Date: Tue, 11 Apr 2023 13:19:15 +0100

* doc/guix.texi (Build Phases): Use G-Expressions for example.
---
 doc/guix.texi | 33 +++++++++++++++++++--------------
 1 file changed, 19 insertions(+), 14 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index fa6c9f46a3..62513a4182 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -10131,23 +10131,28 @@ Build Phases
     ;; other fields omitted
     (build-system gnu-build-system)
     (arguments
-     '(#:phases (modify-phases %standard-phases
-                  (delete 'configure)
-                  (add-before 'build 'set-prefix-in-makefile
-                    (lambda* (#:key outputs #:allow-other-keys)
-                      ;; Modify the makefile so that its
-                      ;; 'PREFIX' variable points to "out".
-                      (let ((out (assoc-ref outputs "out")))
-                        (substitute* "Makefile"
-                          (("PREFIX =.*")
-                           (string-append "PREFIX = "
-                                          out "\n")))))))))))
+     (list
+      #:phases
+      #~(modify-phases %standard-phases
+          (delete 'configure)
+          (add-before 'build 'set-prefix-in-makefile
+            (lambda* (#:key inputs #:allow-other-keys)
+              ;; Modify the makefile so that its
+              ;; 'PREFIX' variable points to #$output and
+              ;; 'XMLLINT' points to the correct path.
+              (substitute* "Makefile"
+                (("PREFIX =.*")
+                 (string-append "PREFIX = " #$output "\n"))
+                (("XMLLINT =.*")
+                 (string-append "XMLLINT = "
+                                (search-input-file inputs "/bin/xmllint")
+                                "\n"))))))))))
 @end lisp
 
 The new phase that is inserted is written as an anonymous procedure,
-introduced with @code{lambda*}; it honors the @code{outputs} parameter
-we have seen before.  @xref{Build Utilities}, for more about the helpers
-used by this phase, and for more examples of @code{modify-phases}.
+introduced with @code{lambda*}.  @xref{Build Utilities}, for more about
+the helpers used by this phase, and for more examples of
+@code{modify-phases}.
 
 @cindex code staging
 @cindex staging, of code

base-commit: 0356087f4e669a79d62d413498c32e4ecb79ba6b
-- 
2.39.2

Message #14 received at 62754 <at> debbugs.gnu.org (full text, mbox):

From: Nicolas Goaziou <mail <at> nicolasgoaziou.fr>
To: Bruno Victal <mirai <at> makinata.eu>
Cc: 62754 <at> debbugs.gnu.org, ivan-p-sokolov <at> ya.ru
Subject: Re: [bug#62754] [PATCH v2] doc: Use G-Expressions for package
 definition example.
Date: Fri, 21 Apr 2023 10:21:50 +0200

Hello,

Bruno Victal <mirai <at> makinata.eu> writes:

> +     (list
> +      #:phases
> +      #~(modify-phases %standard-phases
> +          (delete 'configure)
> +          (add-before 'build 'set-prefix-in-makefile
> +            (lambda* (#:key inputs #:allow-other-keys)
> +              ;; Modify the makefile so that its
> +              ;; 'PREFIX' variable points to #$output and
> +              ;; 'XMLLINT' points to the correct path.
> +              (substitute* "Makefile"
> +                (("PREFIX =.*")
> +                 (string-append "PREFIX = " #$output "\n"))
> +                (("XMLLINT =.*")
> +                 (string-append "XMLLINT = "
> +                                (search-input-file inputs "/bin/xmllint")
> +                                "\n"))))))))))
>  @end lisp
>  
>  The new phase that is inserted is written as an anonymous procedure,
> -introduced with @code{lambda*}; it honors the @code{outputs} parameter
> -we have seen before.  @xref{Build Utilities}, for more about the helpers
> -used by this phase, and for more examples of @code{modify-phases}.
> +introduced with @code{lambda*}.  @xref{Build Utilities}, for more about
> +the helpers used by this phase, and for more examples of
> +@code{modify-phases}.

I think it still makes sense to refer to `inputs'; it could be
unsettling otherwise. Maybe something along those lines:

    ... introduced with @code{lambda*}; it looks for the @file{xmllint}
    executable in a @file{"/bin"} directory among package's inputs
    (@pxref{package Reference}).  It also honors the @code{outputs}
    parameter we have seen before <at> xref{Build Utilities}, for more...


WDYT?

Regards,
-- 
Nicolas Goaziou

Message #17 received at 62754 <at> debbugs.gnu.org (full text, mbox):

From: Simon Tournier <zimon.toutoune <at> gmail.com>
To: Nicolas Goaziou <mail <at> nicolasgoaziou.fr>, Bruno Victal <mirai <at> makinata.eu>
Cc: 62754 <at> debbugs.gnu.org, ivan-p-sokolov <at> ya.ru
Subject: Re: [bug#62754] [PATCH v2] doc: Use G-Expressions for package
 definition example.
Date: Fri, 05 May 2023 16:06:02 +0200

Hi,

On ven., 21 avril 2023 at 10:21, Nicolas Goaziou <mail <at> nicolasgoaziou.fr> wrote:

>>  The new phase that is inserted is written as an anonymous procedure,
>> -introduced with @code{lambda*}; it honors the @code{outputs} parameter
>> -we have seen before.  @xref{Build Utilities}, for more about the helpers
>> -used by this phase, and for more examples of @code{modify-phases}.
>> +introduced with @code{lambda*}.  @xref{Build Utilities}, for more about
>> +the helpers used by this phase, and for more examples of
>> +@code{modify-phases}.
>
> I think it still makes sense to refer to `inputs'; it could be
> unsettling otherwise. Maybe something along those lines:
>
>     ... introduced with @code{lambda*}; it looks for the @file{xmllint}
>     executable in a @file{"/bin"} directory among package's inputs
>     (@pxref{package Reference}).  It also honors the @code{outputs}
>     parameter we have seen before <at> xref{Build Utilities}, for more...

This tweak looks better to me.  Well, Bruno could you send a v3?  Or
Nicolas, could you amend the patch and directly apply it?

(Note the typo in « before <at> xref{Build Utilities} », I guess.)

Cheers,
simon

Message #20 received at 62754 <at> debbugs.gnu.org (full text, mbox):

From: Bruno Victal <mirai <at> makinata.eu>
To: 62754 <at> debbugs.gnu.org
Cc: Bruno Victal <mirai <at> makinata.eu>, mail <at> nicolasgoaziou.fr,
 zimon.toutoune <at> gmail.com
Subject: [PATCH v3] doc: Use G-Expressions for package definition example.
Date: Sat,  6 May 2023 15:19:40 +0100

* doc/guix.texi (Build Phases): Use G-Expressions for example.

Co-authored-by: Nicolas Goaziou <mail <at> nicolasgoaziou.fr>
---
 doc/guix.texi | 36 ++++++++++++++++++++++--------------
 1 file changed, 22 insertions(+), 14 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 55221a10c3..e4b664aba9 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -10140,23 +10140,31 @@ Build Phases
     ;; other fields omitted
     (build-system gnu-build-system)
     (arguments
-     '(#:phases (modify-phases %standard-phases
-                  (delete 'configure)
-                  (add-before 'build 'set-prefix-in-makefile
-                    (lambda* (#:key outputs #:allow-other-keys)
-                      ;; Modify the makefile so that its
-                      ;; 'PREFIX' variable points to "out".
-                      (let ((out (assoc-ref outputs "out")))
-                        (substitute* "Makefile"
-                          (("PREFIX =.*")
-                           (string-append "PREFIX = "
-                                          out "\n")))))))))))
+     (list
+      #:phases
+      #~(modify-phases %standard-phases
+          (delete 'configure)
+          (add-before 'build 'set-prefix-in-makefile
+            (lambda* (#:key inputs #:allow-other-keys)
+              ;; Modify the makefile so that its
+              ;; 'PREFIX' variable points to #$output and
+              ;; 'XMLLINT' points to the correct path.
+              (substitute* "Makefile"
+                (("PREFIX =.*")
+                 (string-append "PREFIX = " #$output "\n"))
+                (("XMLLINT =.*")
+                 (string-append "XMLLINT = "
+                                (search-input-file inputs "/bin/xmllint")
+                                "\n"))))))))))
 @end lisp
 
 The new phase that is inserted is written as an anonymous procedure,
-introduced with @code{lambda*}; it honors the @code{outputs} parameter
-we have seen before.  @xref{Build Utilities}, for more about the helpers
-used by this phase, and for more examples of @code{modify-phases}.
+introduced with @code{lambda*}; it looks for the @file{xmllint}
+executable under a @file{/bin} directory among the package's inputs
+(@pxref{package Reference}).  It also honors the @code{outputs} parameter
+we have seen before.  @xref{Build Utilities}, for more about
+the helpers used by this phase, and for more examples of
+@code{modify-phases}.
 
 @cindex code staging
 @cindex staging, of code

base-commit: 1cb0dee3a31c6d235389d4d9787fa583c2babc30
-- 
2.39.2

Message #25 received at 62754-done <at> debbugs.gnu.org (full text, mbox):

From: Ludovic Courtès <ludo <at> gnu.org>
To: Bruno Victal <mirai <at> makinata.eu>
Cc: 62754-done <at> debbugs.gnu.org, mail <at> nicolasgoaziou.fr,
 zimon.toutoune <at> gmail.com
Subject: Re: bug#62754: [PATCH] doc: Use G-Expressions for package
 definition example.
Date: Sat, 06 May 2023 18:08:28 +0200

Hi,

Bruno Victal <mirai <at> makinata.eu> skribis:

> * doc/guix.texi (Build Phases): Use G-Expressions for example.
>
> Co-authored-by: Nicolas Goaziou <mail <at> nicolasgoaziou.fr>

Applied, thank you, and thanks Simon and Nicolas!

Ludo’.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.