[PATCH] gnu: Add emacs-noman.

  • Done
  • quality assurance status badge
Details
3 participants
  • Dale Mellor
  • Nicolas Goaziou
  • Suhail Singh
Owner
Somebody
Submitted by
Suhail Singh
Severity
normal

Debbugs page

S
S
Suhail Singh wrote on 19 Mar 05:23 -0700
(name . Guix-patches mailing list)(address . guix-patches@gnu.org)
8f9780091f344a39655f715faf32e2903cc4dd19.1710850789.git.suhail@bayesians.ca
* gnu/packages/emacs-xyz.scm (emacs-noman): New variable.

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

Toggle diff (39 lines)
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
D
D
Dale Mellor wrote on 8 Apr 08:36 -0700
Difficult to use this package.
(address . 69896@debbugs.gnu.org)
c686af18472adfe2f55f083f7051a3f87a2a6d4f.camel@rdmp.org
I have sent an issue upstream at Github
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).
S
S
Suhail Singh wrote on 8 Apr 23:11 -0700
(name . Dale Mellor)(address . guix-devel-0brg6a@rdmp.org)(address . 69896@debbugs.gnu.org)
87o7ajxdy6.fsf@gmail.com
Dale Mellor <guix-devel-0brg6a@rdmp.org> writes:

Toggle quote (4 lines)
> 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.

Toggle quote (2 lines)
> 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
S
S
Suhail Singh wrote on 10 Apr 18:43 -0700
[PATCH v2] gnu: Add emacs-noman.
(address . 69896@debbugs.gnu.org)
c5500a726749e4bdfda0d3d809a3ef9314073b97.1712799395.git.suhail@bayesians.ca
* gnu/packages/emacs-xyz.scm (emacs-noman): New variable.

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

Toggle diff (37 lines)
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
D
D
Dale Mellor wrote on 11 Apr 12:16 -0700
[PATCH v3] gnu: Add emacs-noman.
(address . 69896@debbugs.gnu.org)
20240411191605.1308781-1-guix-devel-0brg6a@rdmp.org
From: Suhail Singh <suhailsingh247@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@rdmp.org>
Change-Id: I4ef3de3723025832c6b6eae47de67c3377366602
---
gnu/packages/emacs-xyz.scm | 22 ++++++++++++++++++++++
1 file changed, 22 insertions(+)

Toggle diff (35 lines)
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
D
D
Dale Mellor wrote on 11 Apr 12:23 -0700
69896 looks good
(name . control)(address . control@debbugs.gnu.org)
a5e5fb2ec51f34e4907199a2b10fb144de36c89d.camel@rdmp.org
owner 69896 !
user guix
usertag 69896 + reviewed-looks-good
quit
S
S
Suhail Singh wrote on 11 Apr 16:49 -0700
[PATCH v4] gnu: Add emacs-noman.
(address . 69896@debbugs.gnu.org)(name . Dale Mellor)(address . guix-devel-0brg6a@rdmp.org)
c5500a726749e4bdfda0d3d809a3ef9314073b97.1712879109.git.suhail@bayesians.ca
* gnu/packages/emacs-xyz.scm (emacs-noman): New variable.

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

Toggle diff (37 lines)
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
S
S
Suhail Singh wrote on 11 Apr 16:56 -0700
Re: [bug#69896] [PATCH v3] gnu: Add emacs-noman.
(name . Dale Mellor)(address . guix-devel-0brg6a@rdmp.org)(address . 69896@debbugs.gnu.org)
878r1jmp1y.fsf@gmail.com
Dale Mellor <guix-devel-0brg6a@rdmp.org> writes:

Toggle quote (10 lines)
> 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
N
N
Nicolas Goaziou wrote on 15 Apr 03:15 -0700
Re: [bug#69896] [PATCH v4] gnu: Add emacs-noman.
(name . Suhail Singh)(address . suhailsingh247@gmail.com)
878r1flynh.fsf@nicolasgoaziou.fr
Hello,

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

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

Applied, thank you.

Toggle quote (11 lines)
> +(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
Closed
?
Your comment

This issue is archived.

To comment on this conversation send an email to 69896@patchwise.org

To respond to this issue using the mumi CLI, first switch to it
mumi current 69896
Then, you may apply the latest patchset in this issue (with sign off)
mumi am -- -s
Or, compose a reply to this issue
mumi compose
Or, send patches to this issue
mumi send-email *.patch