GNU bug report logs - #65118
[PATCH 0/9]: gnu: Add NSQ.

Previous Next

Full log

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

From: Maxim Cournoyer <maxim.cournoyer <at> gmail.com>
To: Sharlatan Hellseher <sharlatanus <at> gmail.com>
Cc: 65118 <at> debbugs.gnu.org
Subject: Re: bug#65118: [PATCH 0/9]: gnu: Add NSQ.
Date: Sat, 26 Aug 2023 22:23:00 -0400

Sharlatan Hellseher <sharlatanus <at> gmail.com> writes:

> * gnu/packages/golang.scm (go-github-com-nsqio-go-nsq): New variable.
> ---
>  gnu/packages/golang.scm | 24 ++++++++++++++++++++++++
>  1 file changed, 24 insertions(+)
>
> diff --git a/gnu/packages/golang.scm b/gnu/packages/golang.scm
> index 637e6ebe73..91b1880476 100644
> --- a/gnu/packages/golang.scm
> +++ b/gnu/packages/golang.scm
> @@ -3205,6 +3205,30 @@ (define-public go-github-com-nsqio-go-diskqueue
>       "This package provides a Go package providing a filesystem-backed FIFO queue")
>      (license license:expat)))
>  
> +(define-public go-github-com-nsqio-go-nsq
> +  (package
> +    (name "go-github-com-nsqio-go-nsq")
> +    (version "1.1.0")
> +    (source (origin
> +              (method git-fetch)
> +              (uri (git-reference
> +                    (url "https://github.com/nsqio/go-nsq")
> +                    (commit (string-append "v" version))))
> +              (file-name (git-file-name name version))
> +              (sha256
> +               (base32
> +                "1h9z3z225sdgg7fl3l7x11xn5ch6lm5flgmcj046cdp453qj2qhf"))))
> +    (build-system go-build-system)
> +    (arguments
> +     (list #:tests? #f ;It requires local network setup.
> +           #:import-path "github.com/nsqio/go-nsq"))
> +    (propagated-inputs (list go-github-com-golang-snappy))
> +    (home-page "https://github.com/nsqio/go-nsq")
> +    (synopsis "Golang package of high-level Consumer and Produce for NSQ")
> +    (description "Package nsq is the official Go package for NSQ
> +(@url{http://nsq.io/,http://nsq.io/}).")

The description should provide more detail than the synopsis, not less
:-).  I'd use something like this, inspired by [0].

--8<---------------cut here---------------start------------->8---
The @code{nsq} Go module provides a high-level consumer and producer
types as well as low-level functions to communicate over the NSQ
protocol.
--8<---------------cut here---------------end--------------->8---

Another thing; when the URL name is the same as the URL itself, you
don't need to repeat it in the @url command.

[0]  https://pkg.go.dev/github.com/nsqio/go-nsq?utm_source=godoc#section-documentation

-- 
Thanks,
Maxim

Previous Next

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