# NEWS file rename

- Thread: https://externals.io/message/66448
- Original archive: https://news-web.php.net/php.internals/66448
- Started by Derick Rethans on 2013-03-03T19:00:47+00:00
- Messages: 14
- Reply by email to internals@lists.php.net
- More for agents: search with https://externals.io/search.md?q={query} · JSON API at https://externals.io/api · documentation at https://externals.io/llms.txt

---

## #66448 — Derick Rethans — 2013-03-03T19:00:47+00:00

URL: https://externals.io/message/66448#66448

Hi,

I've just renamed the NEWS files to a branch specific variant. NEWS 
files should not be merged up (as their contents are not linked) and 
they always cause a bit pain when doing automated things (such as the 
tzdb update).

cheers,
Derick

---

## #66449 — Gustavo Lopes — 2013-03-03T19:29:16+00:00

URL: https://externals.io/message/66448#66449 · In reply to: #66448

On Sun, 03 Mar 2013 20:00:47 +0100, Derick Rethans  
<derick@derickrethans.nl> wrote:

> Hi,
>
> I've just renamed the NEWS files to a branch specific variant. NEWS
> files should not be merged up (as their contents are not linked) and
> they always cause a bit pain when doing automated things (such as the
> tzdb update).
>

How does that fix anything? You'll still have a conflict because you'll be  
changing a file that doesn't exist in the other branch.

Besides, the solution is well documented on the wiki:

https://wiki.php.net/vcs/gitfaq#mandatory_git_settings


-- 
Gustavo Lopes

---

## #66451 — Stas Malyshev — 2013-03-03T20:04:02+00:00

URL: https://externals.io/message/66448#66451 · In reply to: #66448

Hi!

> I've just renamed the NEWS files to a branch specific variant. NEWS 
> files should not be merged up (as their contents are not linked) and 
> they always cause a bit pain when doing automated things (such as the 
> tzdb update).

I would really prefer first asking, then doing things to stable repos.
And NEWS merging is working just fine in git, what exactly is the
problem with that? We have special hooks in place just for that, and I
have never seen any problem with them.
-- 
Stanislav Malyshev, Software Architect
SugarCRM: http://www.sugarcrm.com/
(408)454-6900 ext. 227

---

## #66452 — Derick Rethans — 2013-03-03T21:01:00+00:00

URL: https://externals.io/message/66448#66452 · In reply to: #66451

> > […]
> 
> I would really prefer first asking, then doing things to stable repos. 
> And NEWS merging is working just fine in git, what exactly is the 
> problem with that? We have special hooks in place just for that, and I 
> have never seen any problem with them.

Everytime I want to merge up from PHP-5.3 to 5.4 to 5.5 to master for 
the timezone database I get conflicts in NEWS, I don't even touch that 
file.

cheers,
Derick

---

## #66453 — Derick Rethans — 2013-03-03T21:02:32+00:00

URL: https://externals.io/message/66448#66453 · In reply to: #66449

> On Sun, 03 Mar 2013 20:00:47 +0100, Derick Rethans <derick@derickrethans.nl>
> wrote:
> 
> > […]
> 
> How does that fix anything? You'll still have a conflict because 
> you'll be changing a file that doesn't exist in the other branch.

Maybe, but right now it frustrates me every time.

> Besides, the solution is well documented on the wiki:
> 
> https://wiki.php.net/vcs/gitfaq#mandatory_git_settings

Yeah, right. That is not a solution, but a hack. NEWS should just be 
outside of GIT at all as you can not rely on everybody having that hack 
in their config.

cheers,
Derick

---

## #66454 — Stas Malyshev — 2013-03-03T21:02:50+00:00

URL: https://externals.io/message/66448#66454 · In reply to: #66452

Hi!

> Everytime I want to merge up from PHP-5.3 to 5.4 to 5.5 to master for 
> the timezone database I get conflicts in NEWS, I don't even touch that 
> file.

Did you set up git as described in
https://wiki.php.net/vcs/gitfaq#mandatory_git_settings ? Because I never
had merge conflicts in NEWS, it shouldn't be even possible with this
setup...

-- 
Stanislav Malyshev, Software Architect
SugarCRM: http://www.sugarcrm.com/
(408)454-6900 ext. 227

---

## #66455 — Derick Rethans — 2013-03-03T21:12:13+00:00

URL: https://externals.io/message/66448#66455 · In reply to: #66454

> > […]
> 
> Did you set up git as described in 
> https://wiki.php.net/vcs/gitfaq#mandatory_git_settings ? Because I 
> never had merge conflicts in NEWS, it shouldn't be even possible with 
> this setup...

I have never seen that, but I do consider that a hack. You will never 
get everybody to make that configuration. Feel free to revert it.

cheers,
Derick

---

## #66456 — Stas Malyshev — 2013-03-03T21:18:34+00:00

URL: https://externals.io/message/66448#66456 · In reply to: #66455

Hi!

> I have never seen that, but I do consider that a hack. You will never 
> get everybody to make that configuration. Feel free to revert it.

Well, I think it works reasonable well (it did for me). It is a hack,
but it gets the job done and it's pretty easy. Maybe it has to be more
visible or if there's some way of integrating it in the repo (like
.gitignore) it'd be excellent, but my git knowledge is not enough for
that. David, any ideas how to make this easier?
-- 
Stanislav Malyshev, Software Architect
SugarCRM: http://www.sugarcrm.com/
(408)454-6900 ext. 227

---

## #66457 — Ferenc Kovacs — 2013-03-03T22:33:17+00:00

URL: https://externals.io/message/66448#66457 · In reply to: #66456

On Sun, Mar 3, 2013 at 10:18 PM, Stas Malyshev <smalyshev@sugarcrm.com>wrote:

> Hi!
>
> > […]
>
> Well, I think it works reasonable well (it did for me). It is a hack,
> but it gets the job done and it's pretty easy. Maybe it has to be more
> visible or if there's some way of integrating it in the repo (like
> .gitignore) it'd be excellent, but my git knowledge is not enough for
> that. David, any ideas how to make this easier?
> --
> Stanislav Malyshev, Software Architect
> SugarCRM: http://www.sugarcrm.com/
> (408)454-6900 ext. 227
>
> --
> 
> 
>
>
I suppose we could use a .gitattributes file:
http://blog.mindlesstechie.net/2012/08/17/always-keep-your-copy-of-a-particular-file-in-a-git-merge/


-- 
Ferenc Kovács
@Tyr43l - http://tyrael.hu

---

## #66458 — Stas Malyshev — 2013-03-03T23:15:14+00:00

URL: https://externals.io/message/66448#66458 · In reply to: #66457

Hi!

> I suppose we could use a .gitattributes file:
> http://blog.mindlesstechie.net/2012/08/17/always-keep-your-copy-of-a-particular-file-in-a-git-merge/

You still have to do git config with this solution. The whole problem is
that not everybody knows that it needs to be done.
-- 
Stanislav Malyshev, Software Architect
SugarCRM: http://www.sugarcrm.com/
(408)454-6900 ext. 227

---

## #66459 — Pierre Joye — 2013-03-04T04:59:02+00:00

URL: https://externals.io/message/66448#66459 · In reply to: #66448

hi Derick,


> Hi,
>
> I've just renamed the NEWS files to a branch specific variant. NEWS
> files should not be merged up (as their contents are not linked) and
> they always cause a bit pain when doing automated things (such as the
> tzdb update).

Commit first and then ask (well, inform us in this case...) is not
going to work very well.

About this issue, there are different problems to solve.

If developers does not setup his git correctly, then we have to make
the points listed in the FAQ more visible. Maybe on www as well, or at
least a link with "Please configure git correctly as described in...".
Also not only NEWS should be there but the various UPGRADING files as
well. That's something you would notice as soon as you implement new
things.

I'd to agree on one thing tho'. NEWS should not be manually edited.
With or without git, it is a (relatively small) pain. Back to the git
migration time, David and I discussed about generating it from the
commit messages. That implies to enforce a commit message format, a
1st attempt is described here:
https://wiki.php.net/vcs/gitworkflow#new_commit_message_format. The
RMs could then call a script to generate it on release.


Cheers,
--
Pierre

@pierrejoye

---

## #66460 — Pierre Joye — 2013-03-04T06:20:15+00:00

URL: https://externals.io/message/66448#66460 · In reply to: #66455

> 
>
> > […]
>
> Feel free to revert it.

Huh well... Apparently not a lot of people like this change, if one
has to do it then you :-)

Cheers,
-- 
Pierre

@pierrejoye

---

## #66461 — Stas Malyshev — 2013-03-04T06:23:17+00:00

URL: https://externals.io/message/66448#66461 · In reply to: #66459

Hi!

> I'd to agree on one thing tho'. NEWS should not be manually edited.
> With or without git, it is a (relatively small) pain. Back to the git
> migration time, David and I discussed about generating it from the
> commit messages. That implies to enforce a commit message format, a
> 1st attempt is described here:
> https://wiki.php.net/vcs/gitworkflow#new_commit_message_format. The
> RMs could then call a script to generate it on release.

Commit messages themselves won't be very useful - a fix could include a
number of commits, and people regularly write commit messages not in
format suitable for NEWS. I'd rather prefer them to put it in NEWS file
- where they have an example of how it's done right, and where they can
put it in proper order, proper sections, etc.
It won't save much work because if people would neglect to do it with
NEWS file, they'd also neglect to put messages in commit in proper
format, so they will have to be hand-edited anyway. So we don't win much
by telling people not to bother about NEWS anymore - I'd rather have
them to bother with it and make RM's life a bit easier.

-- 
Stanislav Malyshev, Software Architect
SugarCRM: http://www.sugarcrm.com/
(408)454-6900 ext. 227

---

## #66462 — Pierre Joye — 2013-03-04T06:27:23+00:00

URL: https://externals.io/message/66448#66462 · In reply to: #66461

> Hi!
>
> > […]
>
> Commit messages themselves won't be very useful - a fix could include a
> number of commits, and people regularly write commit messages not in
> format suitable for NEWS. I'd rather prefer them to put it in NEWS file
> - where they have an example of how it's done right, and where they can
> put it in proper order, proper sections, etc.
> It won't save much work because if people would neglect to do it with
> NEWS file, they'd also neglect to put messages in commit in proper
> format,

Well, we could write a pre commit script and reject commits with
invalid messages, hard but fair :)

Cheers,
-- 
Pierre

@pierrejoye
