GNU bug report logs - #62059
'guix style' loses comments

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 62059 in the body.
You can then email your comments to 62059 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: Maxim Cournoyer <maxim.cournoyer <at> gmail.com>
To: bug-guix <bug-guix <at> gnu.org>
Subject: guix style looses comments
Date: Wed, 08 Mar 2023 17:20:38 -0500

Hello,

Consider this package:

--8<---------------cut here---------------start------------->8---
(define-public ruby-webrick
  (package
    (name "ruby-webrick")
    (version "1.8.1")
    (source (origin
              (method git-fetch)
              (uri (git-reference
                    (url "https://github.com/ruby/webrick")
                    (commit (string-append "v" version))))
              (file-name (git-file-name name version))
              (sha256
               (base32
                "1xb0mk3cghdir65nmj0mblprbf21blli7267b6yyvxclh307yp6s"))))
    (build-system ruby-build-system)
    (arguments (list #:phases #~(modify-phases %standard-phases
                                  (add-after 'extract-gemspec 'delete-problematic-tests
                                    (lambda _
                                      ;; The httresponse tests fail for
                                      ;; unknown reasons (see:
                                      ;; https://github.com/ruby/webrick/issues/112).
                                      (delete-file "test/webrick/test_httpresponse.rb"))))))
    (home-page "https://github.com/ruby/webrick")
    (synopsis "HTTP server toolkit")
    (description "WEBrick is an HTTP server toolkit that can be configured as an
HTTPS server, a proxy server, and a virtual-host server.")
    (license license:bsd-2)))
--8<---------------cut here---------------end--------------->8---

After running ./pre-inst-env guix style ruby-webrick, it produces:

--8<---------------cut here---------------start------------->8---
(define-public ruby-webrick
  (package
    (name "ruby-webrick")
    (version "1.8.1")
    (source (origin
              (method git-fetch)
              (uri (git-reference
                    (url "https://github.com/ruby/webrick")
                    (commit (string-append "v" version))))
              (file-name (git-file-name name version))
              (sha256
               (base32
                "1xb0mk3cghdir65nmj0mblprbf21blli7267b6yyvxclh307yp6s"))))
    (build-system ruby-build-system)
    (arguments
     (list #:phases #~(modify-phases %standard-phases
                        (add-after 'extract-gemspec 'delete-problematic-tests
                          (lambda _
                            (delete-file "test/webrick/test_httpresponse.rb"))))))
    (home-page "https://github.com/ruby/webrick")
    (synopsis "HTTP server toolkit")
    (description
     "WEBrick is an HTTP server toolkit that can be configured as an
HTTPS server, a proxy server, and a virtual-host server.")
    (license license:bsd-2)))
--8<---------------cut here---------------end--------------->8---

I.e., it lost the comment in the phase.  It also causes the longest line
to be 82 chars, while it could have easily broken the line to make it
fit under 80.

-- 
Thanks,
Maxim

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

From: Ludovic Courtès <ludo <at> gnu.org>
To: Maxim Cournoyer <maxim.cournoyer <at> gmail.com>
Cc: 62059-done <at> debbugs.gnu.org
Subject: Re: bug#62059: 'guix style' loses comments
Date: Thu, 16 Mar 2023 23:05:19 +0100

Hi,

Maxim Cournoyer <maxim.cournoyer <at> gmail.com> skribis:

>      (list #:phases #~(modify-phases %standard-phases
>                         (add-after 'extract-gemspec 'delete-problematic-tests
>                           (lambda _
>                             (delete-file "test/webrick/test_httpresponse.rb"))))))
>     (home-page "https://github.com/ruby/webrick")
>     (synopsis "HTTP server toolkit")
>     (description
>      "WEBrick is an HTTP server toolkit that can be configured as an
> HTTPS server, a proxy server, and a virtual-host server.")
>     (license license:bsd-2)))
>
> I.e., it lost the comment in the phase.

Fixed in 83128f00e9149f3c1bcd4450eb0ed3620a37149c.

> It also causes the longest line to be 82 chars, while it could have
> easily broken the line to make it fit under 80.

Hmm let’s investigate that separately.

Thanks,
Ludo’.

Previous Next

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