On 01/24/2016 07:43 PM, Ulrich Mueller wrote:
>>>>>> On Sun, 24 Jan 2016, Gokturk Yuksek wrote:
>
>> From: Michael Orlitzky <[email protected]>
>
>> The ChangeLog section under misc-files is misleading now that our main
>> repository has been switched to git (and we no longer have
>> ChangeLogs). Remove the ebuild-writing/misc-files/changelog page.
>
> Most of that section contains information that will still apply, even
> if it no longer goes into a ChangeLog but a into a git commit message.
>
> Therefore the section shouldn't be removed, but rather be updated.
>
We will eventually need a "Commit Messages" page, but in my opinion the
bar for these sorts of patches should be "does it make things better?"
If so, merge it, and if you want to improve the result, do that.
Otherwise nothing gets done.
The ChangeLog page is nonsense as-is, and removing it makes the
devmanual better. Afterwards, if someone wants to take the commit
message guidelines from the wiki and merge them with the old ChangeLog
tips, great. There's only two things worth salvaging from the ChangeLog
page. Here's the combined list:
1. Everything from the Git workflow wiki page "Commit message format"
section.
2. Mention the "Gentoo-Bug:" identifier. Using "bug #12345" in the
commit message itself causes trouble. If you word-wrap on the
"#12345", it will silently clobber the message.
3. When including user-submitted ebuilds or patches, you should
credit the user with his full name and email address (or
whatever he uses to identify himself on bugzilla — some users
prefer to be known only by a nickname).
3.i. But use the "Reported-By:", "Suggested-By:", etc. mentioned on
the wiki.
4. If you are changing keywords, make sure you clearly state what
keywords you add or remove.
The bad examples at the end of the ChangeLog page are still bad, but the
good examples are now bad too. There's not much worth saving.
