GNU bug report logs - #41181
adds emacs-interleave

Previous Next

Package: guix-patches;

Reported by: rdes <rdes <at> protonmail.com>

Date: Sun, 10 May 2020 20:22:01 UTC

Severity: normal

Done: Nicolas Goaziou <mail <at> nicolasgoaziou.fr>

Bug is archived. No further changes may be made.

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 41181 in the body.
You can then email your comments to 41181 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

View this report as an mbox folder, status mbox, maintainer mbox


Report forwarded to guix-patches <at> gnu.org:
bug#41181; Package guix-patches. (Sun, 10 May 2020 20:22:01 GMT) Full text and rfc822 format available.

Acknowledgement sent to rdes <rdes <at> protonmail.com>:
New bug report received and forwarded. Copy sent to guix-patches <at> gnu.org. (Sun, 10 May 2020 20:22:02 GMT) Full text and rfc822 format available.

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

From: rdes <rdes <at> protonmail.com>
To: "guix-patches <at> gnu.org" <guix-patches <at> gnu.org>
Subject: adds emacs-interleave
Date: Sun, 10 May 2020 19:35:17 +0000
[Message part 1 (text/plain, inline)]
Hello,

The attached patch adds the emacs-interleave package.

Ryan Desfosses
[Message part 2 (text/html, inline)]
[0001-gnu-Add-emacs-interleave.patch (text/x-patch, attachment)]

Information forwarded to guix-patches <at> gnu.org:
bug#41181; Package guix-patches. (Mon, 11 May 2020 07:11:02 GMT) Full text and rfc822 format available.

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

From: Nicolas Goaziou <mail <at> nicolasgoaziou.fr>
To: rdes via Guix-patches via <guix-patches <at> gnu.org>
Cc: 41181 <at> debbugs.gnu.org, rdes <rdes <at> protonmail.com>
Subject: Re: [bug#41181] adds emacs-interleave
Date: Mon, 11 May 2020 09:10:25 +0200
Hello,

rdes via Guix-patches via <guix-patches <at> gnu.org> writes:

> The attached patch adds the emacs-interleave package.

Thank you! Some comments follow.

> Subject: [PATCH] gnu: Add emacs-interleave

Your commit message should conform to Guix rules. Here, you need to add

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

> +(define-public emacs-interleave
> +(package

Indentation seems wrong.

> +  (name "emacs-interleave")
> +  (version "20191129.958")
> +  (source
> +    (origin
> +      (method url-fetch)
> +      (uri (string-append
> +             "https://melpa.org/packages/interleave-"
> +             version
> +             ".el"))

We do not use MELPA sources. Instead, you could use `git-fetch' and
extract the latest stable release from here:

  https://github.com/rudolfochrist/interleave/releases

> +      (sha256
> +        (base32
> +          "0y183ggfmkjjywbcqgyinmr21hsg2vaw4d52bg1gsxbp673za2m8"))))

Nitpick: could you move the string on the same line as `base32'?

> +  (build-system emacs-build-system)
> +  (home-page
> +    "https://github.com/rudolfochrist/interleave")

Ditto. Could you move the string on the line above?

> +  (synopsis "Interleaving text books since 2015")

I think this synopsis needs to be reworded. As it is, it may not be
useful.

> +  (description
> +    "Interleave presents your PDF side by side to an [[http://orgmode.org][Org Mode]]

Description uses Texinfo syntax, not Org syntax. In this case, however,
I think "side by side to an Org buffer" is sufficient.

> +buffer with your notes, narrowing down to just those passages that are relevant to
> +the particular page in the document viewer.
> +")

You don't need to end the description with a final newline. It would be
nice to expound it a bit. For example, it could be interesting to know
this is a minor mode.

Don't forget to add a copyright line with your name at the top of the file.

Could you send an updated patch?

Regards,

-- 
Nicolas Goaziou




Information forwarded to guix-patches <at> gnu.org:
bug#41181; Package guix-patches. (Mon, 11 May 2020 07:11:02 GMT) Full text and rfc822 format available.

Information forwarded to guix-patches <at> gnu.org:
bug#41181; Package guix-patches. (Fri, 15 May 2020 20:59:01 GMT) Full text and rfc822 format available.

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

From: rdes <rdes <at> protonmail.com>
To: Nicolas Goaziou <mail <at> nicolasgoaziou.fr>
Cc: "41181 <at> debbugs.gnu.org" <41181 <at> debbugs.gnu.org>,
 rdes via Guix-patches via <guix-patches <at> gnu.org>
Subject: Re: [bug#41181] adds emacs-interleave
Date: Fri, 15 May 2020 20:56:10 +0000
[Message part 1 (text/plain, inline)]
Hello Nicolas,

Thanks for the pointers.  Attached is an updated patch.

Ryan


Sent with ProtonMail Secure Email.

‐‐‐‐‐‐‐ Original Message ‐‐‐‐‐‐‐
On Monday, May 11, 2020 3:10 AM, Nicolas Goaziou <mail <at> nicolasgoaziou.fr> wrote:

> Hello,
>
> rdes via Guix-patches via guix-patches <at> gnu.org writes:
>
> > The attached patch adds the emacs-interleave package.
>
> Thank you! Some comments follow.
>
> > Subject: [PATCH] gnu: Add emacs-interleave
>
> Your commit message should conform to Guix rules. Here, you need to add
>
> -   gnu/packages/emacs-xyz.scm (emacs-interleave): New variable.
>
> > +(define-public emacs-interleave
> > +(package
>
> Indentation seems wrong.
>
> > -   (name "emacs-interleave")
> > -   (version "20191129.958")
> > -   (source
> > -   (origin
> > -        (method url-fetch)
> >
> >
> > -        (uri (string-append
> >
> >
> > -               "https://melpa.org/packages/interleave-"
> >
> >
> > -               version
> >
> >
> > -               ".el"))
> >
> >
>
> We do not use MELPA sources. Instead, you could use `git-fetch' and
> extract the latest stable release from here:
>
> https://github.com/rudolfochrist/interleave/releases
>
> > -        (sha256
> >
> >
> > -          (base32
> >
> >
> > -            "0y183ggfmkjjywbcqgyinmr21hsg2vaw4d52bg1gsxbp673za2m8"))))
> >
> >
>
> Nitpick: could you move the string on the same line as `base32'?
>
> > -   (build-system emacs-build-system)
> > -   (home-page
> > -   "https://github.com/rudolfochrist/interleave")
>
> Ditto. Could you move the string on the line above?
>
> > -   (synopsis "Interleaving text books since 2015")
>
> I think this synopsis needs to be reworded. As it is, it may not be
> useful.
>
> > -   (description
> > -   "Interleave presents your PDF side by side to an [[http://orgmode.org][Org Mode]]
>
> Description uses Texinfo syntax, not Org syntax. In this case, however,
> I think "side by side to an Org buffer" is sufficient.
>
> > +buffer with your notes, narrowing down to just those passages that are relevant to
> > +the particular page in the document viewer.
> > +")
>
> You don't need to end the description with a final newline. It would be
> nice to expound it a bit. For example, it could be interesting to know
> this is a minor mode.
>
> Don't forget to add a copyright line with your name at the top of the file.
>
> Could you send an updated patch?
>
> Regards,
>
> ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
>
> Nicolas Goaziou


[0001-gnu-packages-emacs-xyz.scm-emacs-interleave-New-vari.patch (text/x-patch, attachment)]

Information forwarded to guix-patches <at> gnu.org:
bug#41181; Package guix-patches. (Fri, 15 May 2020 20:59:02 GMT) Full text and rfc822 format available.

Information forwarded to guix-patches <at> gnu.org:
bug#41181; Package guix-patches. (Sun, 17 May 2020 13:19:01 GMT) Full text and rfc822 format available.

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

From: rdes <rdes <at> protonmail.com>
To: Nicolas Goaziou <mail <at> nicolasgoaziou.fr>
Cc: "41181 <at> debbugs.gnu.org" <41181 <at> debbugs.gnu.org>,
 rdes via Guix-patches via <guix-patches <at> gnu.org>
Subject: Re: [bug#41181] adds emacs-interleave
Date: Sun, 17 May 2020 13:18:23 +0000
[Message part 1 (text/plain, inline)]
Hello,

Attached is the copyright line that should have been in the previous patch.

Ryan


Sent with ProtonMail Secure Email.

‐‐‐‐‐‐‐ Original Message ‐‐‐‐‐‐‐
On Friday, May 15, 2020 4:56 PM, rdes <rdes <at> protonmail.com> wrote:

> Hello Nicolas,
>
> Thanks for the pointers. Attached is an updated patch.
>
> Ryan
>
> Sent with ProtonMail Secure Email.
>
> ‐‐‐‐‐‐‐ Original Message ‐‐‐‐‐‐‐
> On Monday, May 11, 2020 3:10 AM, Nicolas Goaziou mail <at> nicolasgoaziou.fr wrote:
>
> > Hello,
> > rdes via Guix-patches via guix-patches <at> gnu.org writes:
> >
> > > The attached patch adds the emacs-interleave package.
> >
> > Thank you! Some comments follow.
> >
> > > Subject: [PATCH] gnu: Add emacs-interleave
> >
> > Your commit message should conform to Guix rules. Here, you need to add
> >
> > -   gnu/packages/emacs-xyz.scm (emacs-interleave): New variable.
> >
> > > +(define-public emacs-interleave
> > > +(package
> >
> > Indentation seems wrong.
> >
> > > -   (name "emacs-interleave")
> > >
> > > -   (version "20191129.958")
> > >
> > > -   (source
> > >
> > > -   (origin
> > >
> > > -          (method url-fetch)
> > >
> > >
> > > -          (uri (string-append
> > >
> > >
> > > -                 "https://melpa.org/packages/interleave-"
> > >
> > >
> > > -                 version
> > >
> > >
> > > -                 ".el"))
> > >
> > >
> >
> > We do not use MELPA sources. Instead, you could use `git-fetch' and
> > extract the latest stable release from here:
> > https://github.com/rudolfochrist/interleave/releases
> >
> > > -          (sha256
> > >
> > >
> > > -            (base32
> > >
> > >
> > > -              "0y183ggfmkjjywbcqgyinmr21hsg2vaw4d52bg1gsxbp673za2m8"))))
> > >
> > >
> >
> > Nitpick: could you move the string on the same line as `base32'?
> >
> > > -   (build-system emacs-build-system)
> > > -   (home-page
> > > -   "https://github.com/rudolfochrist/interleave")
> >
> > Ditto. Could you move the string on the line above?
> >
> > > -   (synopsis "Interleaving text books since 2015")
> >
> > I think this synopsis needs to be reworded. As it is, it may not be
> > useful.
> >
> > > -   (description
> > > -   "Interleave presents your PDF side by side to an [[http://orgmode.org][Org Mode]]
> >
> > Description uses Texinfo syntax, not Org syntax. In this case, however,
> > I think "side by side to an Org buffer" is sufficient.
> >
> > > +buffer with your notes, narrowing down to just those passages that are relevant to
> > > +the particular page in the document viewer.
> > > +")
> >
> > You don't need to end the description with a final newline. It would be
> > nice to expound it a bit. For example, it could be interesting to know
> > this is a minor mode.
> > Don't forget to add a copyright line with your name at the top of the file.
> > Could you send an updated patch?
> > Regards,
> >
> > Nicolas Goaziou


[0001-gnu-packages-emacs-xyz.scm-Add-copyright.patch (text/x-patch, attachment)]

Information forwarded to guix-patches <at> gnu.org:
bug#41181; Package guix-patches. (Sun, 17 May 2020 13:19:02 GMT) Full text and rfc822 format available.

Information forwarded to guix-patches <at> gnu.org:
bug#41181; Package guix-patches. (Sun, 17 May 2020 23:01:01 GMT) Full text and rfc822 format available.

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

From: Nicolas Goaziou <mail <at> nicolasgoaziou.fr>
To: rdes <rdes <at> protonmail.com>
Cc: "41181 <at> debbugs.gnu.org" <41181 <at> debbugs.gnu.org>,
 rdes via Guix-patches via <guix-patches <at> gnu.org>
Subject: Re: [bug#41181] adds emacs-interleave
Date: Mon, 18 May 2020 01:00:33 +0200
Hello,

rdes <rdes <at> protonmail.com> writes:

> Subject: [PATCH] * gnu/packages/emacs-xyz.scm (emacs-interleave): New
>  variable.

Thank you for the updated patch. Some comments follow.

> +(define-public emacs-interleave
> +  (package
> +    (name "emacs-interleave")
> +    (version "1.4.0")
> +    (source
> +     (origin
> +       (method git-fetch)
> +       (uri
> +        (git-reference
> +         (url "https://github.com/rudolfochrist/interleave")
> +         (commit (string-append "interleave-" version))))
> +       (file-name (git-file-name name version))
> +       (sha256
> +        (base32
> +         "0l5b681mrpk12lx5c16m7kc13p29z6zismwg1llsjg7cdmrmsrcb"))))

Could you move the hash on the line above?

> +    (build-system emacs-build-system)
> +    (home-page
> +     "https://github.com/rudolfochrist/interleave")

Could you move the URI on the line above, too?

> +    (synopsis
> +     "A minor mode that presents a document buffer next to an orgmode buffer")

A synopsis does not start with "A". You may want to use "guix lint" to
spot this. 

You might use the summary from the home page:

  (synopsis "Emacs minor mode to interleave notes and text books")

> +    (description
> +     "Interleave is a minor mode that presents a document viewer side
> +by side to an orgmode buffer with your notes relevant to the current
> page.")

"orgmode buffer" -> "an Org buffer"

Could you send an updated patch and merge this with the copyright line
you sent?

Regards,

-- 
Nicolas Goaziou




Information forwarded to guix-patches <at> gnu.org:
bug#41181; Package guix-patches. (Sun, 17 May 2020 23:01:02 GMT) Full text and rfc822 format available.

Information forwarded to guix-patches <at> gnu.org:
bug#41181; Package guix-patches. (Fri, 22 May 2020 01:43:01 GMT) Full text and rfc822 format available.

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

From: rdes <rdes <at> protonmail.com>
To: Nicolas Goaziou <mail <at> nicolasgoaziou.fr>
Cc: "41181\\@debbugs.gnu.org" <41181 <at> debbugs.gnu.org>,
 rdes via Guix-patches via <guix-patches <at> gnu.org>
Subject: Re: [bug#41181] adds emacs-interleave
Date: Fri, 22 May 2020 01:42:22 +0000
[Message part 1 (text/plain, inline)]
Hello Nicolas,

Thanks for the insight.  Attached is a patch with the suggestions from the previous email.

-Ryan


Sent with ProtonMail Secure Email.

‐‐‐‐‐‐‐ Original Message ‐‐‐‐‐‐‐
On Sunday, May 17, 2020 7:00 PM, Nicolas Goaziou <mail <at> nicolasgoaziou.fr> wrote:

&gt; Hello,
&gt;
&gt; rdes rdes <at> protonmail.com writes:
&gt;
&gt; &gt; Subject: [PATCH] * gnu/packages/emacs-xyz.scm (emacs-interleave): New
&gt; &gt; variable.
&gt;
&gt; Thank you for the updated patch. Some comments follow.
&gt;
&gt; &gt; +(define-public emacs-interleave
&gt; &gt;
&gt; &gt; -   (package
&gt; &gt; -   (name "emacs-interleave")
&gt; &gt; -   (version "1.4.0")
&gt; &gt; -   (source
&gt; &gt; -       (origin
&gt; &gt;
&gt; &gt;
&gt; &gt; -         (method git-fetch)
&gt; &gt;
&gt; &gt;
&gt; &gt; -         (uri
&gt; &gt;
&gt; &gt;
&gt; &gt; -          (git-reference
&gt; &gt;
&gt; &gt;
&gt; &gt; -           (url "https://github.com/rudolfochrist/interleave")
&gt; &gt;
&gt; &gt;
&gt; &gt; -           (commit (string-append "interleave-" version))))
&gt; &gt;
&gt; &gt;
&gt; &gt; -         (file-name (git-file-name name version))
&gt; &gt;
&gt; &gt;
&gt; &gt; -         (sha256
&gt; &gt;
&gt; &gt;
&gt; &gt; -          (base32
&gt; &gt;
&gt; &gt;
&gt; &gt; -           "0l5b681mrpk12lx5c16m7kc13p29z6zismwg1llsjg7cdmrmsrcb"))))
&gt; &gt;
&gt; &gt;
&gt;
&gt; Could you move the hash on the line above?
&gt;
&gt; &gt; -   (build-system emacs-build-system)
&gt; &gt; -   (home-page
&gt; &gt; -       "https://github.com/rudolfochrist/interleave")
&gt; &gt;
&gt; &gt;
&gt;
&gt; Could you move the URI on the line above, too?
&gt;
&gt; &gt; -   (synopsis
&gt; &gt; -       "A minor mode that presents a document buffer next to an orgmode buffer")
&gt; &gt;
&gt; &gt;
&gt;
&gt; A synopsis does not start with "A". You may want to use "guix lint" to
&gt; spot this.
&gt;
&gt; You might use the summary from the home page:
&gt;
&gt; (synopsis "Emacs minor mode to interleave notes and text books")
&gt;
&gt; &gt; -   (description
&gt; &gt; -       "Interleave is a minor mode that presents a document viewer side
&gt; &gt;
&gt; &gt;
&gt; &gt;
&gt; &gt; +by side to an orgmode buffer with your notes relevant to the current
&gt; &gt; page.")
&gt;
&gt; "orgmode buffer" -&gt; "an Org buffer"
&gt;
&gt; Could you send an updated patch and merge this with the copyright line
&gt; you sent?
&gt;
&gt; Regards,
&gt;
&gt; ---------------------------------------------------------------------------------------------
&gt;
&gt; Nicolas Goaziou

</mail <at> nicolasgoaziou.fr>
[0001-gnu-packages-emacs-xyz.scm-emacs-interleave-New-vari.patch (text/x-patch, attachment)]

Information forwarded to guix-patches <at> gnu.org:
bug#41181; Package guix-patches. (Fri, 22 May 2020 01:43:02 GMT) Full text and rfc822 format available.

Information forwarded to guix-patches <at> gnu.org:
bug#41181; Package guix-patches. (Mon, 25 May 2020 11:44:01 GMT) Full text and rfc822 format available.

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

From: Nicolas Goaziou <mail <at> nicolasgoaziou.fr>
To: rdes <rdes <at> protonmail.com>
Cc: "41181 <at> debbugs.gnu.org" <41181-done <at> debbugs.gnu.org>,
 rdes via Guix-patches via <guix-patches <at> gnu.org>
Subject: Re: [bug#41181] adds emacs-interleave
Date: Mon, 25 May 2020 13:43:03 +0200
Hello,

rdes <rdes <at> protonmail.com> writes:

> From: Ryan Desfosses <ryan <at> desfo.org>
> Date: Fri, 15 May 2020 16:53:02 -0400
> Subject: [PATCH] * gnu/packages/emacs-xyz.scm (emacs-interleave): New
>  variable.

I fixed the commit message and applied your patch. Thank you.

Regards,

-- 
Nicolas Goaziou




Reply sent to Nicolas Goaziou <mail <at> nicolasgoaziou.fr>:
You have taken responsibility. (Mon, 25 May 2020 11:44:02 GMT) Full text and rfc822 format available.

Notification sent to rdes <rdes <at> protonmail.com>:
bug acknowledged by developer. (Mon, 25 May 2020 11:44:02 GMT) Full text and rfc822 format available.

bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Tue, 23 Jun 2020 11:24:06 GMT) Full text and rfc822 format available.

This bug report was last modified 4 years and 363 days ago.

Previous Next


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