Writing GNU Guix commit messages

Writing GNU Guix commit messages

[Zelphir Kaltstahl]

Hi!

My question is regarding writing of commit messages for sending in patches for
GNU Guix. Previously I tried to simply answer all questions mentioned at

https://www.gnu.org/prep/standards/html_node/Change-Logs.html#Change-Logs

However, it turned out, that that was not the desired format. Now I would like
to make a patch for a new version of a package and I would like to get the
format right this time. I also remember it being mentioned, that there is some
tools distributed with GNU Guix, that is supposed to help with that.

Can you provide links for the documentation of how to get the commit message
right or provide instructions of the necessary steps to take?

Best regards,
Zelphir

-- 
repositories: https://notabug.org/ZelphirKaltstahl

Re: Writing GNU Guix commit messages

[Ricardo Wurmus]

Zelphir Kaltstahl <zelphirkaltstahl@posteo.de> writes:

> I also remember it being mentioned, that there is some
> tools distributed with GNU Guix, that is supposed to help with 
> that.

If you use Emacs and Magit you can use the “update” or “add” 
snippets with Yasnippet, i.e. within the commit message window 
opened by magit just type “add” and hit TAB to expand the snippet.

You can also use etc/committer.scm, which is part of the source 
checkout.  It was written to help with mass-upgrades of CRAN 
packages; it will not do the right thing in all cases.  Notably, 
it has some problems separating consecutive package additions.

-- 
Ricardo

Re: Writing GNU Guix commit messages

[Zelphir Kaltstahl]

Hi Ricardo!

Thanks for your reply!

I am using Emacs and Magit, but not yet Yasnippet. Is the snippet for Yasnippet
loaded from the source code of Guix automatically? I imagine I have to somehow
add this snippet first, before I can use it. Or perhaps there is some special
yasnippet file, which yasnippet recognizes and then it completes from that?

About etc/committer.scm: I assume, that I would run this using "guile
etc/committer.scm". Is that the correct way to go?

Best regards,
Zelphir

On 7/26/21 12:03 AM, Ricardo Wurmus wrote:
>
> Zelphir Kaltstahl <zelphirkaltstahl@posteo.de> writes:
>
>> I also remember it being mentioned, that there is some
>> tools distributed with GNU Guix, that is supposed to help with that.
>
> If you use Emacs and Magit you can use the “update” or “add” snippets with
> Yasnippet, i.e. within the commit message window opened by magit just type
> “add” and hit TAB to expand the snippet.
>
> You can also use etc/committer.scm, which is part of the source checkout.  It
> was written to help with mass-upgrades of CRAN packages; it will not do the
> right thing in all cases.  Notably, it has some problems separating
> consecutive package additions.
>
-- 
repositories: https://notabug.org/ZelphirKaltstahl

Re: Writing GNU Guix commit messages

[Efraim Flashner]

[-- Attachment #1: Type: text/plain, Size: 1869 bytes --]

etc/committer.scm is already processed and ready to run, so you can run
it as ./etc/committer.scm

It does choke on some things like changing the copyright lines, since it
thinks it should be a separate commit.

On Tue, Jul 27, 2021 at 08:23:18AM +0000, Zelphir Kaltstahl wrote:
> Hi Ricardo!
> 
> Thanks for your reply!
> 
> I am using Emacs and Magit, but not yet Yasnippet. Is the snippet for Yasnippet
> loaded from the source code of Guix automatically? I imagine I have to somehow
> add this snippet first, before I can use it. Or perhaps there is some special
> yasnippet file, which yasnippet recognizes and then it completes from that?
> 
> About etc/committer.scm: I assume, that I would run this using "guile
> etc/committer.scm". Is that the correct way to go?
> 
> Best regards,
> Zelphir
> 
> On 7/26/21 12:03 AM, Ricardo Wurmus wrote:
> >
> > Zelphir Kaltstahl <zelphirkaltstahl@posteo.de> writes:
> >
> >> I also remember it being mentioned, that there is some
> >> tools distributed with GNU Guix, that is supposed to help with that.
> >
> > If you use Emacs and Magit you can use the “update” or “add” snippets with
> > Yasnippet, i.e. within the commit message window opened by magit just type
> > “add” and hit TAB to expand the snippet.
> >
> > You can also use etc/committer.scm, which is part of the source checkout.  It
> > was written to help with mass-upgrades of CRAN packages; it will not do the
> > right thing in all cases.  Notably, it has some problems separating
> > consecutive package additions.
> >
> -- 
> repositories: https://notabug.org/ZelphirKaltstahl
> 
> 

-- 
Efraim Flashner   <efraim@flashner.co.il>   אפרים פלשנר
GPG key = A28B F40C 3E55 1372 662D  14F7 41AA E7DC CA3D 8351
Confidentiality cannot be guaranteed on emails sent or received unencrypted

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]