bug#43090: emacs-clojure-mode 5.12.0 build failure

bug#43090: emacs-clojure-mode 5.12.0 build failure

[Giovanni Biscuolo]

[-- Attachment #1: Type: text/plain, Size: 1925 bytes --]

Hello,

I'm on latest master:

--8<---------------cut here---------------start------------->8---

Generation 10   Aug 28 2020 18:19:10    (current)
    guix 95eade1
    repository URL: https://git.savannah.gnu.org/git/guix.git
    branch: master
    commit: 95eade1389beaad79f6d07c7ffeff4235424eab0

--8<---------------cut here---------------end--------------->8---

guix build `emacs-clojure-mode` fails with this error:

--8<---------------cut here---------------start------------->8---

starting phase `check'
Loading /gnu/store/8w81gl56lxaylbyslzz3z32k6fxacl66-emacs-buttercup-1.23/share/emacs/site-lisp/buttercup-autoloads...
Loading /gnu/store/rc5in960n20xsb21dr3ri71mx1vswqd9-emacs-dash-2.17.0/share/emacs/site-lisp/dash-autoloads...
Loading /gnu/store/hfmbkal5jfnz0zix4iw8f2wf6zmnr39h-emacs-paredit-24/share/emacs/site-lisp/paredit-autoloads...
Loading /gnu/store/cc556b4zrqkgk8yhy9f4b354w0pqdm4p-emacs-s-1.12.0/share/emacs/site-lisp/s-autoloads...
Running tests on Emacs 27.1
Loading /tmp/guix-build-emacs-clojure-mode-5.12.0.drv-0/source/clojure-mode.el (source)...
Warning (emacs): 
clojure-mode.el:1761: All variables and subroutines might as well have a documentation string
Failing due to checkdoc warnings...
command "buttercup" failed with status 1

--8<---------------cut here---------------end--------------->8---

It's an upstream issue and Jack Hill reported this issue 23 days ago
https://github.com/clojure-emacs/clojure-mode/issues/568.

It was emacs-clojure-mode-5.11.0, different line but same code:

--8<---------------cut here---------------start------------->8---

;; project.el integration
(cl-defmethod project-roots ((project (head clojure)))
  (list (cdr project)))

--8<---------------cut here---------------end--------------->8---

I'll propose a patch as soon as I'm able.

Thanks! Gio'

-- 
Giovanni Biscuolo

Xelera IT Infrastructures

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

bug#43090: [PATCH] emacs-clojure-mode 5.12.0 build failure

[Giovanni Biscuolo]

[-- Attachment #1.1: Type: text/plain, Size: 198 bytes --]

Hello,

this patch fixes the bug: I was able to build emacs-clojure-mode in a
./pre-inst-env

Actually I don't really know what should be the docstring content, it's
just a quick and dirt hack :-)


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.2: 0001-gnu-emacs-clojure-mode-Fix-test.patch --]
[-- Type: text/x-diff, Size: 2575 bytes --]

From f24494b3cbcdfba7cc711ef2f9e16c9c18d1e3a4 Mon Sep 17 00:00:00 2001
From: Giovanni Biscuolo <g@xelera.eu>
Date: Sat, 29 Aug 2020 16:07:41 +0200
Subject: [PATCH] gnu: emacs-clojure-mode: Fix test

Fix missing docstring test.

Close bug#43090

* gnu/packages/emacs-xyz.scm: Add patches to origin, with emacs-clojure-mode-fix-failing-docsting-test.patch
* gnu/packages/patches/emacs-clojure-mode-fix-failing-docsting-test.patch: New file
---
 gnu/packages/emacs-xyz.scm                    |  4 ++-
 ...ojure-mode-fix-failing-docsting-test.patch | 27 +++++++++++++++++++
 2 files changed, 30 insertions(+), 1 deletion(-)
 create mode 100644 gnu/packages/patches/emacs-clojure-mode-fix-failing-docsting-test.patch

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index 0755926ffe..01daea8a57 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -7174,7 +7174,9 @@ allowing unprefixed keys to insert their respective characters as expected.")
              (commit version)))
        (file-name (git-file-name name version))
        (sha256
-        (base32 "14ipfy9ji39pnb9x7bzjp8lyqyxk168fx017m823j7a2g9i0sgp3"))))
+        (base32 "14ipfy9ji39pnb9x7bzjp8lyqyxk168fx017m823j7a2g9i0sgp3"))
+       (patches
+          (search-patches "emacs-clojure-mode-fix-failing-docsting-test.patch"))))
     (build-system emacs-build-system)
     (native-inputs
      `(("emacs-buttercup" ,emacs-buttercup)
diff --git a/gnu/packages/patches/emacs-clojure-mode-fix-failing-docsting-test.patch b/gnu/packages/patches/emacs-clojure-mode-fix-failing-docsting-test.patch
new file mode 100644
index 0000000000..367dc3cf00
--- /dev/null
+++ b/gnu/packages/patches/emacs-clojure-mode-fix-failing-docsting-test.patch
@@ -0,0 +1,27 @@
+From 5fb8ba78f01b6e9cd2079710fc18ecc5e18ab07e Mon Sep 17 00:00:00 2001
+From: Giovanni Biscuolo <g@xelera.eu>
+Date: Sat, 29 Aug 2020 15:18:21 +0200
+Subject: [PATCH] Fix failing docsting test
+
+Fixes bug#43090
+
+* clojure-mode.el: Add docstring to (cl-defmethod project-roots...)
+---
+ clojure-mode.el | 1 +
+ 1 file changed, 1 insertion(+)
+
+diff --git a/clojure-mode.el b/clojure-mode.el
+index 4f615bf..9f1202f 100644
+--- a/clojure-mode.el
++++ b/clojure-mode.el
+@@ -1758,6 +1758,7 @@ Return nil if not inside a project."
+ 
+ ;; project.el integration
+ (cl-defmethod project-roots ((project (head clojure)))
++  "project.el integration"
+   (list (cdr project)))
+ 
+ (defun clojure-project-relative-path (path)
+-- 
+2.27.0
+
-- 
2.27.0


[-- Attachment #1.3: Type: text/plain, Size: 71 bytes --]


Thanks, Gio'

-- 
Giovanni Biscuolo

Xelera IT Infrastructures

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

bug#43090: [PATCH] emacs-clojure-mode 5.12.0 build failure

[Oleg Pykhalov]

[-- Attachment #1: Type: text/plain, Size: 574 bytes --]

Hi,

Giovanni Biscuolo <g@xelera.eu> writes:

> this patch fixes the bug: I was able to build emacs-clojure-mode in a
> ./pre-inst-env
>
> Actually I don't really know what should be the docstring content, it's
> just a quick and dirt hack :-)

My guess "Return a list of project roots." is better for this.

I think this patch should be sended directly to upstream.  Also a
question to the developer about new release (git tag) would be great, so
we could just refresh package version in our recipe.  If you don't have
an account, I could send it if you don't mind.

Oleg.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

bug#43090: [PATCH] emacs-clojure-mode 5.12.0 build failure

[Giovanni Biscuolo]

[-- Attachment #1: Type: text/plain, Size: 855 bytes --]

Hi Oleg,

Oleg Pykhalov <go.wigust@gmail.com> writes:

[...]

> My guess "Return a list of project roots." is better for this.

Thank you for yous suggestion, I've updated the patch.

> I think this patch should be sended directly to upstream.

Yes, I'll be glad to send a pull request upstream as soon as I can but
IMHO we need this patch in Guix ASAP since this bug is breaking all
emacs upgrades using emacs-clojure-mode

> Also a question to the developer about new release (git tag) would be
> great, so we could just refresh package version in our recipe.

Yes, this patch should go in the next upstream release 

> If you don't have an account, I could send it if you don't mind.

Please feel free to send a pull request upstream, thank you! :-)

Happy hacking! Gio'

-- 
Giovanni Biscuolo

Xelera IT Infrastructures

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

bug#43090: [PATCH] emacs-clojure-mode 5.12.0 build failure

[Oleg Pykhalov]

[-- Attachment #1: Type: text/plain, Size: 313 bytes --]

Giovanni Biscuolo <g@xelera.eu> writes:

[…]

>> If you don't have an account, I could send it if you don't mind.
>
> Please feel free to send a pull request upstream, thank you! :-)

I've opened the pull request and pushed the fix as
0c9ead50289be04e2186666b808d0431d9326a64 to Guix master.

Oleg.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]