GNU bug report logs - #69896
[PATCH] gnu: Add emacs-noman.

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 69896 in the body.
You can then email your comments to 69896 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: "Suhail Singh" <suhailsingh247 <at> gmail.com>
To: Guix-patches mailing list <guix-patches <at> gnu.org>
Subject: [PATCH] gnu: Add emacs-noman.
Date: Tue, 19 Mar 2024 08:23:53 -0400

* gnu/packages/emacs-xyz.scm (emacs-noman): New variable.

Change-Id: I4ef3de3723025832c6b6eae47de67c3377366602
---
 gnu/packages/emacs-xyz.scm | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index 83e79544ee..a5b9973f0a 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -5434,6 +5434,30 @@ (define-public emacs-mmt
 Lisp developers who want to write macros with convenience.")
     (license license:gpl3+)))
 
+(define-public emacs-noman
+  (let ((commit "d49ab414c1c6d08a8a9552db27adac0648b282f7")
+        (revision "0"))
+    (package
+      (name "emacs-noman")
+      (home-page "https://github.com/andykuszyk/noman.el")
+      (version (git-version "0.2" revision commit))
+      (source
+       (origin
+         (method git-fetch)
+         (uri (git-reference
+               (url home-page)
+               (commit commit)))
+         (file-name (git-file-name name version))
+         (sha256
+          (base32 "0kcjma1snma17dj32smg75wikwhagn0g14jghhkr8xij429ddsn8"))))
+      (build-system emacs-build-system)
+      (synopsis "Emacs package for browsing CLI command docs without man pages")
+      (description
+       "@code{noman} is an Emacs package that parses command line help from
+flags like @code{--help}, and presents it in an easy-to-navigate Emacs
+buffer.")
+      (license license:gpl3+))))
+
 (define-public emacs-tablist
   (package
     (name "emacs-tablist")

base-commit: c8556379c3f2d3d095a178858915720f2eebc012
-- 
2.44.0

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

From: Dale Mellor <guix-devel-0brg6a <at> rdmp.org>
To: 69896 <at> debbugs.gnu.org
Subject: Difficult to use this package.
Date: Mon, 08 Apr 2024 16:36:17 +0100

I have sent an issue upstream at Github
(https://github.com/andykuszyk/noman.el/issues/5): this package does not seem to
work very well with the GIT command.

I see you are a contributor to the package; if you can I would suggest that when
you bump the version in the code, that you also tag it in the GIT repository,
use that tag in the Guix package definition, and keep the Guix version string
simple (there should be no need to include the GIT fingerprint in the version
number).

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

From: Suhail Singh <suhailsingh247 <at> gmail.com>
To: Dale Mellor <guix-devel-0brg6a <at> rdmp.org>
Cc: 69896 <at> debbugs.gnu.org
Subject: Re: [bug#69896] Difficult to use this package.
Date: Tue, 09 Apr 2024 02:11:45 -0400

Dale Mellor <guix-devel-0brg6a <at> rdmp.org> writes:

> I see you are a contributor to the package; if you can I would suggest
> that when you bump the version in the code, that you also tag it in
> the GIT repository

While I have contributed patches, I do not have permission to create
tags upstream.

> use that tag in the Guix package definition

If/when upstream creates tags, I can update the patch to use those
instead.  Till that happens, are there any other changes that would
improve the current patch submission?

-- 
Suhail

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

From: "Suhail Singh" <suhailsingh247 <at> gmail.com>
To: 69896 <at> debbugs.gnu.org
Subject: [PATCH v2] gnu: Add emacs-noman.
Date: Wed, 10 Apr 2024 21:43:12 -0400

* gnu/packages/emacs-xyz.scm (emacs-noman): New variable.

Change-Id: I4ef3de3723025832c6b6eae47de67c3377366602
---
 gnu/packages/emacs-xyz.scm | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index f35aa3e514..7b362686fe 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -5445,6 +5445,28 @@ (define-public emacs-mmt
 Lisp developers who want to write macros with convenience.")
     (license license:gpl3+)))
 
+(define-public emacs-noman
+  (package
+    (name "emacs-noman")
+    (home-page "https://github.com/andykuszyk/noman.el")
+    (version "0.3")
+    (source
+     (origin
+       (method git-fetch)
+       (uri (git-reference
+             (url home-page)
+             (commit (string-append "v" version))))
+       (file-name (git-file-name name version))
+       (sha256
+        (base32 "04hvh816a0dvakgn22lxzw8qjmvc8grb5nhg1b5w99j5606ljqcl"))))
+    (build-system emacs-build-system)
+    (synopsis "Emacs package for browsing CLI command docs without man pages")
+    (description
+     "@code{noman} is an Emacs package that parses command line help from
+flags like @code{--help}, and presents it in an easy-to-navigate Emacs
+buffer.")
+    (license license:gpl3+)))
+
 (define-public emacs-tablist
   (package
     (name "emacs-tablist")

base-commit: c1c9d6b3cdf5955f1bf5fded2a0c496ce2e631f1
-- 
2.44.0

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

From: Dale Mellor <guix-devel-0brg6a <at> rdmp.org>
To: 69896 <at> debbugs.gnu.org
Cc: Dale Mellor <guix-devel-0brg6a <at> rdmp.org>,
 Suhail Singh <suhailsingh247 <at> gmail.com>, guix-patches <at> gnu.org
Subject: [PATCH v3] gnu: Add emacs-noman.
Date: Thu, 11 Apr 2024 20:16:05 +0100

From: Suhail Singh <suhailsingh247 <at> gmail.com>

* gnu/packages/emacs-xyz.scm (emacs-noman): New variable.

Review:
  * Synopsis and description are brief but fine
  * License is correct
  * Patch applies clean, guix lint and guix build --check report no problems
    are introduced
  * Tested by installing, adding '(require 'noman)' to emacs.el, running emacs
    and issuing 'M-x noman<ret>git<ret>' and then navigating the help pages
    (this is actually pretty cool!)
  * *Very* cursory look over the upstream source code shows nothing malicious

Reviewed-by: Dale Mellor <guix-devel-0brg6a <at> rdmp.org>
Change-Id: I4ef3de3723025832c6b6eae47de67c3377366602
---
 gnu/packages/emacs-xyz.scm | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index f35aa3e514..49e385f466 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -5445,6 +5445,28 @@ (define-public emacs-mmt
 Lisp developers who want to write macros with convenience.")
     (license license:gpl3+)))
 
+(define-public emacs-noman
+  (package
+    (name "emacs-noman")
+    (home-page "https://github.com/andykuszyk/noman.el")
+    (version "0.3")
+    (source
+     (origin
+       (method git-fetch)
+       (uri (git-reference
+             (url home-page)
+             (commit "v0.3")))
+       (file-name "emacs-noman-0.3")
+       (sha256
+        (base32 "04hvh816a0dvakgn22lxzw8qjmvc8grb5nhg1b5w99j5606ljqcl"))))
+    (build-system emacs-build-system)
+    (synopsis "Emacs package for browsing CLI command docs without man pages")
+    (description
+     "@code{noman} is an Emacs package that parses command line help from
+flags like @code{--help}, and presents it in an easy-to-navigate Emacs
+buffer.")
+    (license license:gpl3+)))
+
 (define-public emacs-tablist
   (package
     (name "emacs-tablist")
-- 
2.41.0

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

From: "Suhail Singh" <suhailsingh247 <at> gmail.com>
To: 69896 <at> debbugs.gnu.org
Cc: Dale Mellor <guix-devel-0brg6a <at> rdmp.org>
Subject: [PATCH v4] gnu: Add emacs-noman.
Date: Thu, 11 Apr 2024 19:49:49 -0400

* gnu/packages/emacs-xyz.scm (emacs-noman): New variable.

Change-Id: I4ef3de3723025832c6b6eae47de67c3377366602
---
 gnu/packages/emacs-xyz.scm | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index f35aa3e514..7b362686fe 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -5445,6 +5445,28 @@ (define-public emacs-mmt
 Lisp developers who want to write macros with convenience.")
     (license license:gpl3+)))
 
+(define-public emacs-noman
+  (package
+    (name "emacs-noman")
+    (home-page "https://github.com/andykuszyk/noman.el")
+    (version "0.3")
+    (source
+     (origin
+       (method git-fetch)
+       (uri (git-reference
+             (url home-page)
+             (commit (string-append "v" version))))
+       (file-name (git-file-name name version))
+       (sha256
+        (base32 "04hvh816a0dvakgn22lxzw8qjmvc8grb5nhg1b5w99j5606ljqcl"))))
+    (build-system emacs-build-system)
+    (synopsis "Emacs package for browsing CLI command docs without man pages")
+    (description
+     "@code{noman} is an Emacs package that parses command line help from
+flags like @code{--help}, and presents it in an easy-to-navigate Emacs
+buffer.")
+    (license license:gpl3+)))
+
 (define-public emacs-tablist
   (package
     (name "emacs-tablist")

base-commit: c1c9d6b3cdf5955f1bf5fded2a0c496ce2e631f1
-- 
2.44.0

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

From: "Suhail Singh" <suhailsingh247 <at> gmail.com>
To: Dale Mellor <guix-devel-0brg6a <at> rdmp.org>
Cc: 69896 <at> debbugs.gnu.org
Subject: Re: [bug#69896] [PATCH v3] gnu: Add emacs-noman.
Date: Thu, 11 Apr 2024 19:56:25 -0400

Dale Mellor <guix-devel-0brg6a <at> rdmp.org> writes:

> Review:
>   * Synopsis and description are brief but fine
>   * License is correct
>   * Patch applies clean, guix lint and guix build --check report no problems
>     are introduced
>   * Tested by installing, adding '(require 'noman)' to emacs.el, running emacs
>     and issuing 'M-x noman<ret>git<ret>' and then navigating the help pages
>     (this is actually pretty cool!)
>   * *Very* cursory look over the upstream source code shows nothing malicious

Thank you for the review!

I noticed that the v3 patch you sent introduced some changes to v2.
Specifically, the commit and file-name fields were being hard-coded
instead of referencing the version and name.  I'm assuming this change
was unintentional and I've reverted it in v4 of the patch.

If, however, the change was intentional, could you please elaborate on
the reasons?

Regards,
-- 
Suhail

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

From: Nicolas Goaziou <mail <at> nicolasgoaziou.fr>
To: "Suhail Singh" <suhailsingh247 <at> gmail.com>
Cc: 69896-done <at> debbugs.gnu.org, Dale Mellor <guix-devel-0brg6a <at> rdmp.org>,
 Katherine Cox-Buday <cox.katherine.e+guix <at> gmail.com>,
 Liliana Marie Prikler <liliana.prikler <at> gmail.com>,
 Andrew Tropin <andrew <at> trop.in>
Subject: Re: [bug#69896] [PATCH v4] gnu: Add emacs-noman.
Date: Mon, 15 Apr 2024 12:15:46 +0200

Hello,

"Suhail Singh" <suhailsingh247 <at> gmail.com> writes:

> * gnu/packages/emacs-xyz.scm (emacs-noman): New variable.

Applied, thank you.

> +(define-public emacs-noman
> +  (package
> +    (name "emacs-noman")
> +    (home-page "https://github.com/andykuszyk/noman.el")
> +    (version "0.3")
> +    (source
> +     (origin
> +       (method git-fetch)
> +       (uri (git-reference
> +             (url home-page)

Nitpick: I admit I am not a huge fan of the "home-page hack", because it
introduces a non-obvious relationship between source and home-page. So
I took the liberty of following standard practices here.

Regards,
-- 
Nicolas Goaziou

Previous Next

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