GNU bug report logs - #52420
admin/release-branch.txt: move NEWS in single commit

Previous Next

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

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

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

From: Stefan Kangas <stefan <at> marxist.se>
To: bug-gnu-emacs <at> gnu.org
Subject: admin/release-branch.txt: move NEWS in single commit
Date: Sat, 11 Dec 2021 01:30:01 +0000

Severity: wishlist

In admin/release-branch.txt, step 4 says:

    Set the version on the master branch to the next major release:

     M-x set-version RET XY+1.0.50 RET

    This creates a new file etc/NEWS.XY.  "git add" it.

I think the instructions should be changed so that the NEWS file is
moved like this:

    git mv etc/NEWS etc/NEWS.NN

And then committed in a single commit.  This way, git will be able to
track it as a rename and we preserve the ability to use git blame, etc.

I'm not sure if any changes will have to be made to set-version in
admin/admin.el.

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: 52420 <at> debbugs.gnu.org
Subject: Re: bug#52420: admin/release-branch.txt: move NEWS in single commit
Date: Sat, 11 Dec 2021 10:16:38 +0200

> From: Stefan Kangas <stefan <at> marxist.se>
> Date: Sat, 11 Dec 2021 01:30:01 +0000
> 
> In admin/release-branch.txt, step 4 says:
> 
>     Set the version on the master branch to the next major release:
> 
>      M-x set-version RET XY+1.0.50 RET
> 
>     This creates a new file etc/NEWS.XY.  "git add" it.
> 
> I think the instructions should be changed so that the NEWS file is
> moved like this:
> 
>     git mv etc/NEWS etc/NEWS.NN
> 
> And then committed in a single commit.  This way, git will be able to
> track it as a rename and we preserve the ability to use git blame, etc.
> 
> I'm not sure if any changes will have to be made to set-version in
> admin/admin.el.

I think we should modify admin.el to use "git mv" and commit that
(after prompting), instead of calling rename-file etc. that it does
today.  IOW, there should be no need to do the above manually.

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

From: Stefan Kangas <stefan <at> marxist.se>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 52420 <at> debbugs.gnu.org
Subject: Re: bug#52420: admin/release-branch.txt: move NEWS in single commit
Date: Sat, 11 Dec 2021 11:19:23 +0100

Eli Zaretskii <eliz <at> gnu.org> writes:

> I think we should modify admin.el to use "git mv" and commit that
> (after prompting), instead of calling rename-file etc. that it does
> today.  IOW, there should be no need to do the above manually.

Yes, that sounds better.

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

From: Stefan Kangas <stefan <at> marxist.se>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 52420 <at> debbugs.gnu.org
Subject: Re: bug#52420: admin/release-branch.txt: move NEWS in single commit
Date: Sun, 26 Dec 2021 17:52:28 -0800

[Message part 1 (text/plain, inline)]

tags 52420 + patch
thanks

Eli Zaretskii <eliz <at> gnu.org> writes:

> I think we should modify admin.el to use "git mv" and commit that
> (after prompting), instead of calling rename-file etc. that it does
> today.  IOW, there should be no need to do the above manually.

How does the attached patch look?

[0001-admin.el-Move-etc-NEWS-to-etc-NEWS.NN-in-one-commit.patch (text/x-diff, attachment)]

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: 52420 <at> debbugs.gnu.org
Subject: Re: bug#52420: admin/release-branch.txt: move NEWS in single commit
Date: Mon, 27 Dec 2021 16:21:49 +0200

> From: Stefan Kangas <stefan <at> marxist.se>
> Date: Sun, 26 Dec 2021 17:52:28 -0800
> Cc: 52420 <at> debbugs.gnu.org
> 
> +  (unless admin-git-command
> +    (user-error "Could not find git in `exec-path'"))

When this happens, I think admin.el should show instructions for how
to do that manually, instead of just displaying an error message.

Other than that, LGTM, thanks.

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

From: Stefan Kangas <stefan <at> marxist.se>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 52420 <at> debbugs.gnu.org
Subject: Re: bug#52420: admin/release-branch.txt: move NEWS in single commit
Date: Mon, 27 Dec 2021 08:11:12 -0800

Eli Zaretskii <eliz <at> gnu.org> writes:

>> +  (unless admin-git-command
>> +    (user-error "Could not find git in `exec-path'"))
>
> When this happens, I think admin.el should show instructions for how
> to do that manually, instead of just displaying an error message.

I'm not sure I understand what you mean here.  Could you elaborate?  For
example, what instructions do you think should we show here?

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: 52420 <at> debbugs.gnu.org
Subject: Re: bug#52420: admin/release-branch.txt: move NEWS in single commit
Date: Mon, 27 Dec 2021 18:50:58 +0200

> From: Stefan Kangas <stefan <at> marxist.se>
> Date: Mon, 27 Dec 2021 08:11:12 -0800
> Cc: 52420 <at> debbugs.gnu.org
> 
> Eli Zaretskii <eliz <at> gnu.org> writes:
> 
> >> +  (unless admin-git-command
> >> +    (user-error "Could not find git in `exec-path'"))
> >
> > When this happens, I think admin.el should show instructions for how
> > to do that manually, instead of just displaying an error message.
> 
> I'm not sure I understand what you mean here.  Could you elaborate?  For
> example, what instructions do you think should we show here?

Something like

  Git was not found, perform "git mv ...." by hand

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

From: Stefan Kangas <stefan <at> marxist.se>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 52420 <at> debbugs.gnu.org
Subject: Re: bug#52420: admin/release-branch.txt: move NEWS in single commit
Date: Mon, 27 Dec 2021 09:32:59 -0800

Eli Zaretskii <eliz <at> gnu.org> writes:

> Something like
>
>   Git was not found, perform "git mv ...." by hand

Could we assume the user even has git installed in that situation?

IOW, how about:

    "Could not find git in `exec-path'; please install git"

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

From: Eli Zaretskii <eliz <at> gnu.org>
To: Stefan Kangas <stefan <at> marxist.se>
Cc: 52420 <at> debbugs.gnu.org
Subject: Re: bug#52420: admin/release-branch.txt: move NEWS in single commit
Date: Mon, 27 Dec 2021 19:56:47 +0200

> From: Stefan Kangas <stefan <at> marxist.se>
> Date: Mon, 27 Dec 2021 09:32:59 -0800
> Cc: 52420 <at> debbugs.gnu.org
> 
> IOW, how about:
> 
>     "Could not find git in `exec-path'; please install git"

  Could not find git; please install git and move NEWS manually

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

From: Stefan Kangas <stefan <at> marxist.se>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 52420 <at> debbugs.gnu.org
Subject: Re: bug#52420: admin/release-branch.txt: move NEWS in single commit
Date: Mon, 27 Dec 2021 11:50:12 -0800

close 52420 29.1
thanks

Eli Zaretskii <eliz <at> gnu.org> writes:

>   Could not find git; please install git and move NEWS manually

Thanks, pushed to master with that change (commit 0fb55c8776).

Previous Next

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