GNU bug report logs - #55674
[PATCH 2/2] gnu: emacs-helpful: Update to 0.19.

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 55674 in the body.
You can then email your comments to 55674 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: Erik Šabič <erik.sab <at> gmail.com>
To: guix-patches <at> gnu.org
Subject: [PATCH 2/2] gnu: emacs-helpful: Update to 0.19.
Date: Fri, 27 May 2022 14:52:42 +0200

* gnu/packages/emacs-xyz.scm (emacs-helpful): Update to 0.19.
---
 gnu/packages/emacs-xyz.scm | 39 ++++++++++++++++++++------------------
 1 file changed, 21 insertions(+), 18 deletions(-)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index f62c733fb5..6a659fabf3 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -20126,27 +20126,29 @@ (define-public emacs-download-region
 (define-public emacs-helpful
   (package
     (name "emacs-helpful")
-    (version "0.18")
-    (source
-     (origin
-       (method git-fetch)
-       (uri (git-reference
-             (url "https://github.com/Wilfred/helpful")
-             (commit version)))
-       (file-name (git-file-name name version))
-       (sha256
-        (base32 "0gdjxykqkal2x765mi51m99i5ql23i1fy909wy4mzj5ajhjfgqcc"))))
+    (version "0.19")
+    (source (origin
+              (method git-fetch)
+              (uri (git-reference
+                    (url "https://github.com/Wilfred/helpful")
+                    (commit version)))
+              (file-name (git-file-name name version))
+              (sha256
+               (base32
+                "0qwsifzsjw95l83m7z07fr9h1sqbhggwmcps1qgbddpan2a8ab8a"))))
     (build-system emacs-build-system)
-    (propagated-inputs
-     (list emacs-elisp-refs emacs-dash emacs-s emacs-f emacs-shut-up))
-    (native-inputs
-     (list emacs-ert-runner emacs-undercover))
+    (propagated-inputs (list emacs-elisp-refs emacs-dash emacs-s emacs-f
+                             emacs-shut-up))
+    (native-inputs (list emacs-ert-runner emacs-undercover))
     (arguments
-     `(#:tests? #t
-       #:test-command '("ert-runner")))
+     ;; Tests are not passing; the author might not be using them anymore.
+     `(#:tests? #f
+       #:test-command
+       '("ert-runner")))
     (home-page "https://github.com/Wilfred/helpful")
     (synopsis "More contextual information in Emacs help")
-    (description "@code{helpful} is an alternative to the built-in Emacs help
+    (description
+     "@code{helpful} is an alternative to the built-in Emacs help
 that provides much more contextual information.
 
 @itemize
@@ -20164,7 +20166,8 @@ (define-public emacs-helpful
 @item Display any keybindings that apply to interactive functions.
 @item Trace, disassemble functions from inside Helpful.  This is discoverable
 and doesn't require memorisation of commands.
-@end itemize\n")
+@end itemize
+")
     (license license:gpl3+)))
 
 (define-public emacs-logview
-- 
2.36.1

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

From: Maxime Devos <maximedevos <at> telenet.be>
To: Erik Šabič <erik.sab <at> gmail.com>, 
 55674 <at> debbugs.gnu.org
Subject: Re: [bug#55674] [PATCH 2/2] gnu: emacs-helpful: Update to 0.19.
Date: Fri, 27 May 2022 15:12:30 +0200

[Message part 1 (text/plain, inline)]

Erik Šabič schreef op vr 27-05-2022 om 14:52 [+0200]:
> +     ;; Tests are not passing; the author might not be using them anymore.
> +     `(#:tests? #f

How do they fail?  They might indicate a real problem in the code
(that's what tests are for -- detecting problems before they are
actually encountered).

Greetings,
Maxime.

[signature.asc (application/pgp-signature, inline)]

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

From: Erik Šabič <erik.sab <at> gmail.com>
To: 55674 <at> debbugs.gnu.org
Subject: Broken tests
Date: Fri, 27 May 2022 16:58:08 +0200

[Message part 1 (text/plain, inline)]

One of the tests fails. Looks like it's testing whether helpful--docstring
and
helpful--docstring-advice figure out that a function is advised.

I've tried using helpful-* functions from this updated package in Emacs,
and it works - advices are shown.

So it looks like the tests are broken.
(but I don't understand the ert tests, maybe someone else
should look at this)

[Message part 2 (text/html, inline)]

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

From: Erik Šabič <erik.sab <at> gmail.com>
To: Maxime Devos <maximedevos <at> telenet.be>
Cc: 55674 <at> debbugs.gnu.org
Subject: Re: [bug#55674] [PATCH 2/2] gnu: emacs-helpful: Update to 0.19.
Date: Fri, 27 May 2022 19:23:20 +0200

Okay, I figured it out. The test is indeed broken and
it's an easy fix. I will try sending a PR on github.

I have a lot to learn. I apologise for being a nuisance :)

Please tell me if there's anything else I can improve on.

Thank you!

here's a diff for the test:

 diff --git a/test/helpful-unit-test.el b/test/helpful-unit-test.el
index a07aa8e..1a61a6f 100644
--- a/test/helpful-unit-test.el
+++ b/test/helpful-unit-test.el
@@ -119,7 +119,7 @@ bar")))
   (should
    (equal
     (helpful--docstring #'test-foo-advised t)
-    "Docstring here too.")))
+    "Docstring here too.\n\nThis function has :around advice:
`ad-Advice-test-foo-advised'.")))

 (defun test-foo-no-docstring ()
   nil)

On Fri, May 27, 2022 at 3:48 PM Maxime Devos <maximedevos <at> telenet.be> wrote:
>
> [Please keep 55675 <at> debbugs.gnu.org in CC]
>
> Erik Šabič schreef op vr 27-05-2022 om 15:32 [+0200]:
> > Well it fails on a test defined like this:
> > (ert-deftest helpful--docstring ()
> >   "Basic docstring fetching."
> >   (should
> >    (equal
> >     (helpful--docstring #'test-foo t)
> >     "Docstring here.")))
> >
> > And fails like so:
> > ...............s...s..Test helpful--docstring-advice backtrace:
>
>
> >
> > Test helpful--docstring-advice condition:
> >
> >     (ert-test-failed
> >      ((should
> >        (equal
> >         (helpful--docstring ... t)
> >         "Docstring here too."))
> >       :form
> >       (equal "Docstring here too.\n\nThis function has :around
> > advice: `ad-Advice-test-foo-advised'." "Docstring here too.")
> >       :value nil :explanation
> >       (arrays-of-different-length 84 19 "Docstring here too.\n\nThis
> > function has :around advice: `ad-Advice-test-foo-advised'."
> > "Docstring here too." first-mismatch-at 19)))
> >
> > F............................................................s......
>
> Looks like a bug.
>
> > I don't know anything about emacs-ert. And I wasn't able to
> > figure out if it works for the upstream author.
> >
> > WDYT?
>
> I don't know if it fails for the upstream author, but I don't think
> that's relevant to Guix.  More relevant I think, is that this bug
> appears in Guix, so it can cause problems for Guix users, so some
> fixing might be necessary.
>
> I don't know much about Emacs though, so you might need to contact
> upstream about the bug.
>
> Greetings,
> Maxime.

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

From: yarl-baudig <at> mailoo.org
To: 55674 <at> debbugs.gnu.org
Subject: PR accepted
Date: Sun, 29 May 2022 07:05:51 +0200 (CEST)

Yes, your pull request have been accepted! Thank you. Mind if I update? I would like helpful to be fixed quickly.

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

From: yarl-baudig <at> mailoo.org
To: 55674 <at> debbugs.gnu.org
Subject: [PATCH] gnu: emacs-helpful: Update to 209971b
Date: Sun, 29 May 2022 07:13:35 +0200 (CEST)

* gnu/packages/emacs-xyz.scm (emacs-helpful): Update to 209971b

Fixes <https://issues.guix.gnu.org/55674>
Thanks to upstream pull request by Erik Šabič
---
 gnu/packages/emacs-xyz.scm | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index 31822dc641..90fd8a49d6 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -20131,7 +20131,7 @@ (define-public emacs-download-region
 (define-public emacs-helpful
   (package
     (name "emacs-helpful")
-    (version "0.18")
+    (version "209971ba9f576ba080352642cfbf25df5692b1d7")
     (source
      (origin
        (method git-fetch)
@@ -20140,7 +20140,7 @@ (define-public emacs-helpful
              (commit version)))
        (file-name (git-file-name name version))
        (sha256
-        (base32 "0gdjxykqkal2x765mi51m99i5ql23i1fy909wy4mzj5ajhjfgqcc"))))
+        (base32 "1qrxr0ybvdvx6qw6akb1pv074bmffv4m57855kk8fr1vp4w07z0i"))))
     (build-system emacs-build-system)
     (propagated-inputs
      (list emacs-elisp-refs emacs-dash emacs-s emacs-f emacs-shut-up))
-- 
2.36.0

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

From: Liliana Marie Prikler <liliana.prikler <at> gmail.com>
To: yarl-baudig <at> mailoo.org, 55674 <at> debbugs.gnu.org
Subject: Re: [PATCH] gnu: emacs-helpful: Update to 209971b
Date: Sun, 29 May 2022 09:41:05 +0200

Am Sonntag, dem 29.05.2022 um 07:13 +0200 schrieb
yarl-baudig <at> mailoo.org:
> * gnu/packages/emacs-xyz.scm (emacs-helpful): Update to 209971b
> 
> Fixes <https://issues.guix.gnu.org/55674>
> Thanks to upstream pull request by Erik Šabič
> ---
>  gnu/packages/emacs-xyz.scm | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
> index 31822dc641..90fd8a49d6 100644
> --- a/gnu/packages/emacs-xyz.scm
> +++ b/gnu/packages/emacs-xyz.scm
> @@ -20131,7 +20131,7 @@ (define-public emacs-download-region
>  (define-public emacs-helpful
>    (package
>      (name "emacs-helpful")
> -    (version "0.18")
> +    (version "209971ba9f576ba080352642cfbf25df5692b1d7")
Commit hashes are not versions.  Furthermore, there has been more than
just that bugfix since – as a workaround I think it'd be more
reasonable to just disable that one test until the next release.

Cheers

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

From: yarl-baudig <at> mailoo.org
To: liliana.prikler <at> gmail.com,
 55674 <at> debbugs.gnu.org
Subject: Re: [PATCH] gnu: emacs-helpful: Update to 209971b
Date: Sun, 29 May 2022 11:09:12 +0200 (CEST)

> Commit hashes are not versions.  Furthermore, there has been more than
> just that bugfix since – as a workaround I think it'd be more
> reasonable to just disable that one test until the next release.

Or Erik Šabič might try its patch against version 0.19 then add it to the package definition and let a comment that as soon as it is updated to 0.20, the patch can go away?

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

From: Liliana Marie Prikler <liliana.prikler <at> gmail.com>
To: yarl-baudig <at> mailoo.org, 55674 <at> debbugs.gnu.org
Subject: Re: [PATCH] gnu: emacs-helpful: Update to 209971b
Date: Sun, 29 May 2022 12:12:56 +0200

Am Sonntag, dem 29.05.2022 um 11:09 +0200 schrieb
yarl-baudig <at> mailoo.org:
> > Commit hashes are not versions.  Furthermore, there has been more
> > than just that bugfix since – as a workaround I think it'd be more
> > reasonable to just disable that one test until the next release.
> 
> Or Erik Šabič might try [their] patch against version 0.19 then add
> it to the package definition and let a comment that as soon as it is
> updated to 0.20, the patch can go away?
That'd work too, but it'd be a slightly larger patch to create :)

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

From: yarl-baudig <at> mailoo.org
To: liliana.prikler <at> gmail.com,
 55674 <at> debbugs.gnu.org
Subject: [PATCH] gnu: emacs-helpful: Update to 0.19
Date: Mon, 30 May 2022 09:20:24 +0200 (CEST)

Includes fixe for test from Erik Šabič against upstream,
see details in the patch file.

* gnu/packages/patches/emacs-helpful-fix-0.19-test.patch: New file.
* gnu/packages/emacs-xyz.scm: Update emacs-helpful to 0.19, use
the patch.
* gnu/local.mk: Update dist_patch_DATA.
---
 gnu/local.mk                                  |  1 +
 gnu/packages/emacs-xyz.scm                    |  7 ++++--
 .../patches/emacs-helpful-fix-0.19-test.patch | 23 +++++++++++++++++++
 3 files changed, 29 insertions(+), 2 deletions(-)
 create mode 100644 gnu/packages/patches/emacs-helpful-fix-0.19-test.patch

diff --git a/gnu/local.mk b/gnu/local.mk
index bc82c5ba9f..71f6b7669a 100644
--- a/gnu/local.mk
+++ b/gnu/local.mk
@@ -1029,6 +1029,7 @@ dist_patch_DATA =						\
   %D%/packages/patches/emacs-git-email-missing-parens.patch	\
   %D%/packages/patches/emacs-fix-scheme-indent-function.patch	\
   %D%/packages/patches/emacs-json-reformat-fix-tests.patch	\
+  %D%/packages/patches/emacs-helpful-fix-0.19-test.patch	\
   %D%/packages/patches/emacs-highlight-stages-add-gexp.patch	\
   %D%/packages/patches/emacs-hyperbole-toggle-messaging.patch	\
   %D%/packages/patches/emacs-libgit-use-system-libgit2.patch    \
diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index 31822dc641..c5fa725bf5 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -20131,7 +20131,7 @@ (define-public emacs-download-region
 (define-public emacs-helpful
   (package
     (name "emacs-helpful")
-    (version "0.18")
+    (version "0.19")
     (source
      (origin
        (method git-fetch)
@@ -20140,7 +20140,10 @@ (define-public emacs-helpful
              (commit version)))
        (file-name (git-file-name name version))
        (sha256
-        (base32 "0gdjxykqkal2x765mi51m99i5ql23i1fy909wy4mzj5ajhjfgqcc"))))
+        (base32 "0qwsifzsjw95l83m7z07fr9h1sqbhggwmcps1qgbddpan2a8ab8a"))
+       ;; TODO: remove this patch as soon as the package is updated to 0.20
+       ;; See explanation in the patch file
+       (patches (search-patches "emacs-helpful-fix-0.19-test.patch"))))
     (build-system emacs-build-system)
     (propagated-inputs
      (list emacs-elisp-refs emacs-dash emacs-s emacs-f emacs-shut-up))
diff --git a/gnu/packages/patches/emacs-helpful-fix-0.19-test.patch b/gnu/packages/patches/emacs-helpful-fix-0.19-test.patch
new file mode 100644
index 0000000000..64000f2b73
--- /dev/null
+++ b/gnu/packages/patches/emacs-helpful-fix-0.19-test.patch
@@ -0,0 +1,23 @@
+Erik Šabič sent a pull request (patches 741b864 and 209971b) against 2f91e79,
+which is not a release.
+This is a diff between 0.19 and those 2 patches applied against 0.19.
+
+So, when 0.20 will be released, this patch can be removed.
+
+The procedure should be as simple as reverting the commit including
+this file then calling `guix refresh emacs-helpful`.
+diff --git a/test/helpful-unit-test.el b/test/helpful-unit-test.el
+index a07aa8e..8a95129 100644
+--- a/test/helpful-unit-test.el
++++ b/test/helpful-unit-test.el
+@@ -119,7 +119,9 @@ bar")))
+   (should
+    (equal
+     (helpful--docstring #'test-foo-advised t)
+-    "Docstring here too.")))
++    (if (version< emacs-version "28")
++        "Docstring here too."
++    "Docstring here too.\n\nThis function has :around advice: `ad-Advice-test-foo-advised'."))))
+ 
+ (defun test-foo-no-docstring ()
+   nil)
-- 
2.36.0

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

From: Liliana Marie Prikler <liliana.prikler <at> gmail.com>
To: yarl-baudig <at> mailoo.org, 55674 <at> debbugs.gnu.org
Subject: Re: [PATCH] gnu: emacs-helpful: Update to 0.19
Date: Mon, 30 May 2022 21:41:32 +0200

Am Montag, dem 30.05.2022 um 09:20 +0200 schrieb
yarl-baudig <at> mailoo.org:
> Includes fixe for test from Erik Šabič against upstream,
> see details in the patch file.
> 
> * gnu/packages/patches/emacs-helpful-fix-0.19-test.patch: New file.
> * gnu/packages/emacs-xyz.scm: Update emacs-helpful to 0.19, use
> the patch.
> * gnu/local.mk: Update dist_patch_DATA.
I locally applied your changes and would be ready to push, but noticed
your mail client is not really set up well ;)

For the sake of attribution, should I set "Yarl Baudig" or something
else as committer name?

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

From: "yarl baudig" <yarl-baudig <at> mailoo.org>
To: liliana.prikler <at> gmail.com,
 55674 <at> debbugs.gnu.org
Subject: Re: [PATCH] gnu: emacs-helpful: Update to 0.19
Date: Mon, 30 May 2022 23:11:59 +0200 (CEST)

> your mail client is not really set up well ;)
> 
> For the sake of attribution, should I set "Yarl Baudig" or something
> else as committer name?
> 

Yes, please. I will try to fix this.
Thank you!

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

From: Liliana Marie Prikler <liliana.prikler <at> gmail.com>
To: yarl baudig <yarl-baudig <at> mailoo.org>, 55674-done <at> debbugs.gnu.org
Subject: Re: [PATCH] gnu: emacs-helpful: Update to 0.19
Date: Sat, 04 Jun 2022 09:00:17 +0200

Am Montag, dem 30.05.2022 um 23:11 +0200 schrieb yarl baudig:
> > your mail client is not really set up well ;)
> > 
> > For the sake of attribution, should I set "Yarl Baudig" or
> > something
> > else as committer name?
> > 
> 
> Yes, please. I will try to fix this.
> Thank you!
Used "yarl baudig" as per this mail.

Previous Next

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