[PATCH] gnu: Add emacs-weblorg

  • Open
  • quality assurance status badge
Details
2 participants
  • Nicolas Goaziou
  • Mattia Bunel
Owner
unassigned
Submitted by
Mattia Bunel
Severity
normal
M
M
Mattia Bunel wrote 3 days ago
(address . guix-patches@gnu.org)(name . Mattia Bunel)(address . mattia.bunel@ehess.fr)
9eb86d322b0944948b166e17a48a3adf9c197996.1730054952.git.mattia.bunel@ehess.fr
Change-Id: Iae2d6cbbadec7a171e1e5b8502d4f47701d7af5b
---
gnu/packages/emacs-xyz.scm | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)

Toggle diff (35 lines)
diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index 488b4cb5d7..0ff7ac08ca 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -38230,6 +38230,26 @@ (define-public emacs-org-static-blog
a @samp{date} keywords, and optionally, a @samp{filetags} keyword.")
(license license:bsd-3)))
+(define-public emacs-weblorg
+ (package
+ (name "emacs-weblorg")
+ (version "0.1.2")
+ (source
+ (origin
+ (method url-fetch)
+ (uri (string-append "https://stable.melpa.org/packages/" "weblorg-"
+ version ".tar"))
+ (sha256
+ (base32 "0lvjfhysiyaz8klbj01da5jdjw1p4vvd9kl1zmi9vciazayh82ch"))))
+ (build-system emacs-build-system)
+ (propagated-inputs (list emacs-templatel))
+ (home-page "https://emacs.love/weblorg")
+ (synopsis "Static site generator for org-mode")
+ (description
+ "@code{emacs-weblorg} is a static site generator for org-mode,
+based on @code{templatel} library.")
+ (license license:gpl3+)))
+
(define-public emacs-ddskk
(let ((commit "8c47f46e38a29a0f3eabcd524268d20573102467")
(revision "0"))

base-commit: 091131af64fd4e4e925fff829fa19097cfcdfcc5
--
2.47.0
N
N
Nicolas Goaziou wrote 3 days ago
(name . Mattia Bunel)(address . mattia.bunel@ehess.fr)
87seshkudj.fsf@nicolasgoaziou.fr
Hello,

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

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

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

Toggle quote (6 lines)
> + (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
(commit commit)))

as the `uri' field.

Also, you need to add

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

before the `sha256' field.

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

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

Nitpick: org-mode -> Org mode

Toggle quote (4 lines)
> + (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
M
M
Mattia Bunel wrote 2 days ago
(name . Nicolas Goaziou)(address . mail@nicolasgoaziou.fr)
055b8d2c-3507-48f9-a269-751492012f19@ehess.fr
Hello Nicolas,

Thanks for your review.

I've written a new patch based on your comments. What is the correct
procedure for sending it? Should I send a patch based on *origin/master*
or the previous patch you reviewed?

For documentation, the weblorg *doc/* folder contains the sources for
the project website. My opinion is therefore not to include them.

Regards,

Le 28/10/2024 à 00:18, Nicolas Goaziou a écrit :
Toggle quote (83 lines)
> 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,
M
M
Mattia Bunel wrote 2 days ago
[PATCH] gnu: Add emacs-weblorg
(address . 74051@debbugs.gnu.org)(name . Mattia Bunel)(address . mattia.bunel@ehess.fr)
8fb16459699509f1e676ad64752bc39030d427c2.1730130134.git.mattia.bunel@ehess.fr
* gnu/packages/emacs-xyz.scm (emacs-weblorg): New Variable.

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

Toggle diff (47 lines)
diff --git a/gnu/packages/emacs-xyz.scm b/gnu/packages/emacs-xyz.scm
index 488b4cb5d7..18ae6937bb 100644
--- a/gnu/packages/emacs-xyz.scm
+++ b/gnu/packages/emacs-xyz.scm
@@ -38230,6 +38230,38 @@ (define-public emacs-org-static-blog
a @samp{date} keywords, and optionally, a @samp{filetags} keyword.")
(license license:bsd-3)))
+(define-public emacs-weblorg
+ (let ((commit "0db218bd6b2e083546d3a69a022dfb1a08900acd")
+ (revision "0"))
+ (package
+ (name "emacs-weblorg")
+ (version (git-version "0.1.2" revision commit))
+ (source
+ (origin
+ (method git-fetch)
+ (uri (git-reference
+ (url "https://github.com/emacs-love/weblorg")
+ (commit commit)))
+ (file-name (git-file-name name version))
+ (sha256
+ (base32 "0fijrzc96p3jkq53i65bzhmxqyg28a49n21glkzb5b21agy0cdqh"))))
+ (build-system emacs-build-system)
+ (arguments
+ (list
+ #:tests? #t
+ #:test-command #~(list "emacs"
+ "--quick"
+ "--batch"
+ "-l"
+ "t/weblorg-tests.el"
+ "-f"
+ "ert-run-tests-batch-and-exit")))
+ (propagated-inputs (list emacs-templatel))
+ (home-page "https://emacs.love/weblorg")
+ (synopsis "Static site generator for Org mode")
+ (description "@code{Weblorg} is a static site generator for Org mode.")
+ (license license:gpl3+))))
+
(define-public emacs-ddskk
(let ((commit "8c47f46e38a29a0f3eabcd524268d20573102467")
(revision "0"))

base-commit: 091131af64fd4e4e925fff829fa19097cfcdfcc5
--
2.47.0
?
Your comment

Commenting via the web interface is currently disabled.

To comment on this conversation send an email to 74051@debbugs.gnu.org

To respond to this issue using the mumi CLI, first switch to it
mumi current 74051
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