Gentoo Archives: gentoo-dev

From: Ulrich Mueller <ulm@g.o>
To: gentoo-dev@l.g.o
Subject: Re: [gentoo-dev] Re: [PATCH v2 17/19] ebuild-writing/misc-files: remove ChangeLog section #485314
Date: Mon, 25 Jan 2016 08:18:03
Message-Id: 22181.55849.309637.405392@a1i15.kph.uni-mainz.de
In Reply to: Re: [gentoo-dev] Re: [PATCH v2 17/19] ebuild-writing/misc-files: remove ChangeLog section #485314 by Michael Orlitzky
1 >>>>> On Sun, 24 Jan 2016, Michael Orlitzky wrote:
2
3 > The ChangeLog page is nonsense as-is, and removing it makes the
4 > devmanual better. Afterwards, if someone wants to take the commit
5 > message guidelines from the wiki and merge them with the old ChangeLog
6 > tips, great. There's only two things worth salvaging from the ChangeLog
7 > page. Here's the combined list:
8
9 > 1. Everything from the Git workflow wiki page "Commit message format"
10 > section.
11
12 I would say not only that section, but most of the page. The devmanual
13 is the one central place where our development workflow should be
14 documented, not some random wiki page.
15
16 > 2. Mention the "Gentoo-Bug:" identifier.
17
18 Right. (But had we settled for "Gentoo-Bug:"? IIRC, last time this was
19 discussed there was no consensus.)
20
21 > Using "bug #12345" in the commit message itself causes trouble.
22 > If you word-wrap on the "#12345", it will silently clobber the
23 > message.
24
25 That's one of the reasons why I have 'commentchar = ";"' in my
26 .gitconfig file. (Not sure if that option would be worth mentioning
27 in our documentation, though.)
28
29 > [...]
30
31 Ulrich

Replies

Subject Author
Re: [gentoo-dev] Re: [PATCH v2 17/19] ebuild-writing/misc-files: remove ChangeLog section #485314 "Göktürk Yüksek" <gokturk@××××××××××.edu>