GNU bug report logs - #61941
[PATCH 1/2] gnu: emacs-helpful: Update to 0.20.1c98f6f.

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 61941 in the body.
You can then email your comments to 61941 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: conses <contact <at> conses.eu>
To: guix-patches <at> gnu.org
Cc: contact <at> conses.eu
Subject: [PATCH 1/2] gnu: emacs-helpful: Update to 0.20.1c98f6f.
Date: Fri, 03 Mar 2023 17:58:26 +0100

* gnu/packages/emacs-xyz.scm (emacs-helpful): Update to 0.20.1c98f6f.
[source]: Remove fix-docstring-test.patch.
[propagated-inputs]: Remove emacs-shut-up.
---
 gnu/packages/emacs-xyz.scm | 52 +++++++++++++++++++-------------------
 1 file changed, 26 insertions(+), 26 deletions(-)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index 3f7fcf4481..a3535728f8 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -23126,31 +23126,31 @@ (define-public emacs-download-region
       (license license:gpl3+))))
 
 (define-public emacs-helpful
-  (package
-    (name "emacs-helpful")
-    (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"))
-       ;; Cherry-picked from upstream, remove when bumping to 0.20.
-       (patches (search-patches "emacs-helpful-fix-docstring-test.patch"))))
-    (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))
-    (arguments
-     `(#:tests? #t
-       #: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
+  (let ((commit "1c98f6f06a85def5d34c735f8cd407f20cebddf9")
+        (revision "0"))
+    (package
+      (name "emacs-helpful")
+      (version (git-version "0.20" revision commit))
+      (source
+       (origin
+         (method git-fetch)
+         (uri (git-reference
+               (url "https://github.com/Wilfred/helpful")
+               (commit commit)))
+         (file-name (git-file-name name version))
+         (sha256
+          (base32 "18b5hjfji51zxjrxhkklxx3j9svk295awmxv8n95mp8ilas2kd3l"))))
+      (build-system emacs-build-system)
+      (propagated-inputs
+       (list emacs-elisp-refs emacs-dash emacs-s emacs-f))
+      (native-inputs
+       (list emacs-ert-runner emacs-undercover))
+      (arguments
+       `(#:tests? #t
+         #: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
 that provides much more contextual information.
 
 @itemize
@@ -23169,7 +23169,7 @@ (define-public emacs-helpful
 @item Trace, disassemble functions from inside Helpful.  This is discoverable
 and doesn't require memorisation of commands.
 @end itemize\n")
-    (license license:gpl3+)))
+      (license license:gpl3+))))
 
 (define-public emacs-logview
   (package
-- 
2.39.1



-- 
Best regards,
conses

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

From: conses <contact <at> conses.eu>
To: 61941 <at> debbugs.gnu.org
Cc: contact <at> conses.eu
Subject: [PATCH 2/2] gnu: Remove unused emacs-helpful-fix-docstring-test.patch.
Date: Fri, 03 Mar 2023 17:59:54 +0100

---
 .../emacs-helpful-fix-docstring-test.patch     | 18 ------------------
 1 file changed, 18 deletions(-)
 delete mode 100644 gnu/packages/patches/emacs-helpful-fix-docstring-test.patch

diff --git a/gnu/packages/patches/emacs-helpful-fix-docstring-test.patch b/gnu/packages/patches/emacs-helpful-fix-docstring-test.patch
deleted file mode 100644
index de40010fa2..0000000000
--- a/gnu/packages/patches/emacs-helpful-fix-docstring-test.patch
+++ /dev/null
@@ -1,18 +0,0 @@
-This patch fixing a build failure has been cherry-picked from upstream.
-Originally submitted as pull request by Erik Šabič.
-See also <https://github.com/Wilfred/helpful/pull/296>.
-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.39.1



-- 
Best regards,
conses

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

From: Nicolas Goaziou <mail <at> nicolasgoaziou.fr>
To: conses <contact <at> conses.eu>
Cc: 61941 <at> debbugs.gnu.org
Subject: Re: [bug#61941] [PATCH 1/2] gnu: emacs-helpful: Update to
 0.20.1c98f6f.
Date: Wed, 08 Mar 2023 15:57:51 +0100

Hello,

conses <contact <at> conses.eu> writes:

> * gnu/packages/emacs-xyz.scm (emacs-helpful): Update to 0.20.1c98f6f.
> [source]: Remove fix-docstring-test.patch.
> [propagated-inputs]: Remove emacs-shut-up.

Thank you. Some comments follow.

> +  (let ((commit "1c98f6f06a85def5d34c735f8cd407f20cebddf9")
> +        (revision "0"))

Is there a particular reason to use an unreleased version?

> +    (package
> +      (name "emacs-helpful")
> +      (version (git-version "0.20" revision commit))

Base version is actually still 0.19. Upstream bumped Version keyword,
but the README mentions there is no official 0.20 yet. I suggest to
stick to 0.19.

> +      (source
> +       (origin
> +         (method git-fetch)
> +         (uri (git-reference
> +               (url "https://github.com/Wilfred/helpful")
> +               (commit commit)))
> +         (file-name (git-file-name name version))
> +         (sha256
> +          (base32 "18b5hjfji51zxjrxhkklxx3j9svk295awmxv8n95mp8ilas2kd3l"))))
> +      (build-system emacs-build-system)
> +      (propagated-inputs
> +       (list emacs-elisp-refs emacs-dash emacs-s emacs-f))

While you're at it, could you re-order inputs alphabetically?

You can also merge both patches.

Regards,
-- 
Nicolas Goaziou

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

From: conses <contact <at> conses.eu>
To: 61941 <at> debbugs.gnu.org
Cc: contact <at> conses.eu, Nicolas Goaziou <mail <at> nicolasgoaziou.fr>
Subject: Re: [bug#61941] [PATCH 1/2] gnu: emacs-helpful: Update to
 0.20.1c98f6f.
Date: Thu, 09 Mar 2023 23:47:29 +0100

Nicolas Goaziou <mail <at> nicolasgoaziou.fr> writes:

>> +  (let ((commit "1c98f6f06a85def5d34c735f8cd407f20cebddf9")
>> +        (revision "0"))
>
> Is there a particular reason to use an unreleased version?
>

The latest release was over two years ago and a lot of functionality has
been added.

>> +    (package
>> +      (name "emacs-helpful")
>> +      (version (git-version "0.20" revision commit))
>
> Base version is actually still 0.19. Upstream bumped Version keyword,
> but the README mentions there is no official 0.20 yet. I suggest to
> stick to 0.19.
>

Ok, will send a revised patch.

>> +      (source
>> +       (origin
>> +         (method git-fetch)
>> +         (uri (git-reference
>> +               (url "https://github.com/Wilfred/helpful")
>> +               (commit commit)))
>> +         (file-name (git-file-name name version))
>> +         (sha256
>> +          (base32 "18b5hjfji51zxjrxhkklxx3j9svk295awmxv8n95mp8ilas2kd3l"))))
>> +      (build-system emacs-build-system)
>> +      (propagated-inputs
>> +       (list emacs-elisp-refs emacs-dash emacs-s emacs-f))
>
> While you're at it, could you re-order inputs alphabetically?
>
> You can also merge both patches.
>

Sure.  Thanks for having a look!

> Regards,

-- 
Best regards,
conses

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

From: conses <contact <at> conses.eu>
To: 61941 <at> debbugs.gnu.org
Cc: contact <at> conses.eu, Nicolas Goaziou <mail <at> nicolasgoaziou.fr>
Subject: [PATCH v2] gnu: emacs-helpful: Update to 0.19.1c98f6f.
Date: Thu, 09 Mar 2023 23:55:37 +0100

* gnu/packages/emacs-xyz.scm (emacs-helpful): Update to 0.19.1c98f6f.
[source]: Remove fix-docstring-test.patch.
[propagated-inputs]: Remove emacs-shut-up.
---
 gnu/packages/emacs-xyz.scm                    | 52 +++++++++----------
 .../emacs-helpful-fix-docstring-test.patch    | 18 -------
 2 files changed, 26 insertions(+), 44 deletions(-)
 delete mode 100644 gnu/packages/patches/emacs-helpful-fix-docstring-test.patch

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index 3c067fe16c..fa528432cb 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -23303,31 +23303,31 @@ (define-public emacs-download-region
       (license license:gpl3+))))
 
 (define-public emacs-helpful
-  (package
-    (name "emacs-helpful")
-    (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"))
-       ;; Cherry-picked from upstream, remove when bumping to 0.20.
-       (patches (search-patches "emacs-helpful-fix-docstring-test.patch"))))
-    (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))
-    (arguments
-     `(#:tests? #t
-       #: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
+  (let ((commit "1c98f6f06a85def5d34c735f8cd407f20cebddf9")
+        (revision "0"))
+    (package
+      (name "emacs-helpful")
+      (version (git-version "0.19" revision commit))
+      (source
+       (origin
+         (method git-fetch)
+         (uri (git-reference
+               (url "https://github.com/Wilfred/helpful")
+               (commit commit)))
+         (file-name (git-file-name name version))
+         (sha256
+          (base32 "18b5hjfji51zxjrxhkklxx3j9svk295awmxv8n95mp8ilas2kd3l"))))
+      (build-system emacs-build-system)
+      (propagated-inputs
+       (list emacs-dash emacs-elisp-refs emacs-f emacs-s))
+      (native-inputs
+       (list emacs-ert-runner emacs-undercover))
+      (arguments
+       `(#:tests? #t
+         #: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
 that provides much more contextual information.
 
 @itemize
@@ -23346,7 +23346,7 @@ (define-public emacs-helpful
 @item Trace, disassemble functions from inside Helpful.  This is discoverable
 and doesn't require memorisation of commands.
 @end itemize\n")
-    (license license:gpl3+)))
+      (license license:gpl3+))))
 
 (define-public emacs-logview
   (package
diff --git a/gnu/packages/patches/emacs-helpful-fix-docstring-test.patch b/gnu/packages/patches/emacs-helpful-fix-docstring-test.patch
deleted file mode 100644
index de40010fa2..0000000000
--- a/gnu/packages/patches/emacs-helpful-fix-docstring-test.patch
+++ /dev/null
@@ -1,18 +0,0 @@
-This patch fixing a build failure has been cherry-picked from upstream.
-Originally submitted as pull request by Erik Šabič.
-See also <https://github.com/Wilfred/helpful/pull/296>.
-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.39.1



-- 
Best regards,
conses

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

From: Nicolas Goaziou <mail <at> nicolasgoaziou.fr>
To: conses <contact <at> conses.eu>
Cc: 61941-done <at> debbugs.gnu.org
Subject: Re: [bug#61941] [PATCH v2] gnu: emacs-helpful: Update to 0.19.1c98f6f.
Date: Fri, 17 Mar 2023 09:25:29 +0100

Hello,

conses <contact <at> conses.eu> writes:

> * gnu/packages/emacs-xyz.scm (emacs-helpful): Update to 0.19.1c98f6f.
> [source]: Remove fix-docstring-test.patch.
> [propagated-inputs]: Remove emacs-shut-up.

You also need to dereference the patch file in gnu/local.mk.

I did that, updated the commit message and applied your patch.

Thank you.

Regards,
-- 
Nicolas Goaziou

Previous Next

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