Gentoo Archives: gentoo-dev

From: gokturk@××××××××××.edu
To: devmanual@g.o
Cc: gentoo-dev@l.g.o, Gokturk Yuksek <gokturk@××××××××××.edu>
Subject: [gentoo-dev] [PATCH v3 06/21] ebuild-writing/user-submitted: do not put user information in ChangeLog #558642
Date: Thu, 04 Feb 2016 01:01:40
Message-Id: 1454547469-22487-7-git-send-email-gokturk@binghamton.edu
In Reply to: [gentoo-dev] [PATCH v3 00/21] devmanual: update the docs for post git-migration by gokturk@binghamton.edu
1 From: Gokturk Yuksek <gokturk@××××××××××.edu>
2
3 ChangeLog files are auto-generated by infra post git-migration.
4 For user-submitted ebuilds, include the user information in the commit
5 message instead. Mention that user submitted git patches and pull
6 requests preserve the authorship information by default.
7
8 Gentoo-Bug: https://bugs.gentoo.org/show_bug.cgi?id=558642
9 Signed-off-by: Gokturk Yuksek <gokturk@××××××××××.edu>
10 ---
11 ebuild-writing/user-submitted/text.xml | 10 ++++++----
12 1 file changed, 6 insertions(+), 4 deletions(-)
13
14 diff --git a/ebuild-writing/user-submitted/text.xml b/ebuild-writing/user-submitted/text.xml
15 index ef80c0d..a148042 100644
16 --- a/ebuild-writing/user-submitted/text.xml
17 +++ b/ebuild-writing/user-submitted/text.xml
18 @@ -16,14 +16,16 @@ the ebuild meets all Gentoo Linux development standards.
19 The user-submitted ebuild must not contain custom headers like this:
20 </p>
21
22 -<pre caption="A custom header that should be transferred to the ChangeLog">
23 +<pre caption="A custom header that should be included in the commit message instead">
24 # Ebuild updated by: me &lt;me@×××××××.com&gt;
25 </pre>
26
27 <p>
28 -Such information should be added to the <c>ChangeLog</c> instead.
29 -The first <c>ChangeLog</c> entry should always credit the user who
30 -submitted the ebuild, with their full name and e-mail address.
31 +Such information should be included in the git commit message instead.
32 +Note that ebuilds received in the form of git patches or pull requests
33 +will have the user as the commit author by default, in which case
34 +including the user information in the commit message explicitly
35 +may not be necessary.
36 </p>
37
38 <p>
39 --
40 2.4.10