#74051 - [PATCH] gnu: Add emacs-weblorg

Package	Source(s)		Maintainer(s)
guix-patches		PTS Buildd Popcon

Message #8 received at 74051@debbugs.gnu.org (full text, mbox, reply):

Received: (at 74051) by debbugs.gnu.org; 27 Oct 2024 23:19:17 +0000
From debbugs-submit-bounces@debbugs.gnu.org Sun Oct 27 19:19:17 2024
Received: from localhost ([127.0.0.1]:47455 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces@debbugs.gnu.org>)
	id 1t5CXU-00055N-GQ
	for submit@debbugs.gnu.org; Sun, 27 Oct 2024 19:19:17 -0400
Received: from msg-3.mailo.com ([213.182.54.8]:35780 helo=mailo.com)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <mail@nicolasgoaziou.fr>) id 1t5CXS-00054i-Pl
 for 74051@debbugs.gnu.org; Sun, 27 Oct 2024 19:19:15 -0400
DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=nicolasgoaziou.fr;
 s=mailo; t=1730071111;
 bh=6+eUIAeyKIJdRJHcy77nLXfyJwDokdvljaAjlgKC9yM=;
 h=X-EA-Auth:From:To:Cc:Subject:In-Reply-To:References:Date:
 Message-ID:MIME-Version:Content-Type;
 b=KpOXkjg2nENJbD9wNJsXhK6y9tEt5YgLGxZcv8oRoJAUGnS2ZDhjoc8+ur16bkR4r
 /CDNr0huYyhwtQGMgJ7t0DftmDPAJJQMWfVG38+Ry5oB2NKYZ4dclRiJVidmRGYlgY
 VMC6G06Sd+HovJ+tvK2/4xf0zoW/bFk2aPi7WXPQ=
Received: by b221-4.in.mailobj.net [192.168.90.24] with ESMTP
 via ip-20.mailobj.net [213.182.54.20]
 Mon, 28 Oct 2024 00:18:31 +0100 (CET)
X-EA-Auth: sCsWTBAPT/uBvw2t+vBqBm/FP0AqwAuo9wAzLshogwFS4aUq0ugSkgAaivLoqVXfTqLx+ADiM3AEc0RTRn2LwNCoOYR1hMDDrnU04rgTevE=
From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: Mattia Bunel <mattia.bunel@ehess.fr>
Subject: Re: [bug#74051] [PATCH] gnu: Add emacs-weblorg
In-Reply-To: <9eb86d322b0944948b166e17a48a3adf9c197996.1730054952.git.mattia.bunel@ehess.fr>
 (Mattia Bunel's message of "Sun, 27 Oct 2024 19:49:12 +0100")
References: <9eb86d322b0944948b166e17a48a3adf9c197996.1730054952.git.mattia.bunel@ehess.fr>
Date: Mon, 28 Oct 2024 00:18:16 +0100
Message-ID: <87seshkudj.fsf@nicolasgoaziou.fr>
User-Agent: Gnus/5.13 (Gnus v5.13)
MIME-Version: 1.0
Content-Type: text/plain
X-Spam-Score: 0.7 (/)
X-Debbugs-Envelope-To: 74051
Cc: 74051@debbugs.gnu.org, Katherine Cox-Buday <cox.katherine.e+guix@gmail.com>,
 Liliana Marie Prikler <liliana.prikler@gmail.com>,
 Andrew Tropin <andrew@trop.in>
X-BeenThere: debbugs-submit@debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request@debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit@debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request@debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request@debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces@debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces@debbugs.gnu.org>
X-Spam-Score: -0.3 (/)

Hello,

Mattia Bunel <mattia.bunel@ehess.fr> writes:

> Change-Id: Iae2d6cbbadec7a171e1e5b8502d4f47701d7af5b

Thank you for your patch. There are some (small) things to fix before it
can be merged, tho.

First you need to write a proper commit message, such as:

  gnu: Add emacs-weblorg.

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

> +(define-public emacs-weblorg
> +  (package
> +    (name "emacs-weblorg")
> +    (version "0.1.2")

The version is not actually "0.1.2", or rather, it seems we need to pick
a commit after this tag. You should let-bind the commit hash, i.e.,
"0db218bd6b2e083546d3a69a022dfb1a08900acd", to a `commit' symbol.
Then, `version' field would become:

  (version (git-version "0.1.2" revision commit))

See, e.g., `emacs-taskrunner' package definition.

> +    (source
> +     (origin
> +       (method url-fetch)
> +       (uri (string-append "https://stable.melpa.org/packages/" "weblorg-"
> +                           version ".tar"))

Upstream is on GitHub, not on Stable MELPA. The package should use
`git-fetch' method, and

  (uri (git-reference
        (url "https://github.com/emacs-love/weblorg")
        (commit commit)))

as the `uri' field.

Also, you need to add

  (file-name (git-file-name name version))

before the `sha256' field.

> +       (sha256
> +        (base32 "0lvjfhysiyaz8klbj01da5jdjw1p4vvd9kl1zmi9vciazayh82ch"))))
> +    (build-system emacs-build-system)

There are tests. You may want to run them, probably with

  (arguments
   (list #:tests? #t
         #:test-command '("emacs" "--batch"
                          "-l" "t/weblorg-tests.el"
                          "-f" "ert-run-tests-batch-and-exit")))

There seem to be some documentation in the "doc/" directory. What should
be done about it?

> +    (propagated-inputs (list emacs-templatel))
> +    (home-page "https://emacs.love/weblorg")
> +    (synopsis "Static site generator for org-mode")

Nitpick: org-mode -> Org mode

> +    (description
> +     "@code{emacs-weblorg} is a static site generator for org-mode,
> +based on @code{templatel} library.")

Nitpick: @code{emacs-weblorg} -> Weblorg, org-mode -> Org mode. I also
suggest to remove the reference about Templatel library in the
description.

Could you send an updated patch? If you have any trouble doing so,
please let us know.

Regards,
-- 
Nicolas Goaziou

Display info messages

Send a report that this bug log contains spam.

debbugs.gnu.org maintainers <help-debbugs@gnu.org>. Last modified: Sun Jan 5 00:57:57 2025; Machine Name: wallace-server

GNU bug tracking system

Debbugs is free software and licensed under the terms of the GNU Public License version 2. The current version can be obtained from https://bugs.debian.org/debbugs-source/.

#74051 [PATCH] gnu: Add emacs-weblorg