Gentoo Archives: gentoo-commits

From: "Ulrich Müller" <ulm@g.o>
To: gentoo-commits@l.g.o
Subject: [gentoo-commits] proj/devmanual:master commit in: ebuild-writing/file-format/, ebuild-writing/common-mistakes/
Date: Tue, 28 Feb 2017 21:41:36
Message-Id: 1488318001.4db82d56dd51b51748ea6000a3f2f10a2544ffd2.ulm@gentoo
1 commit: 4db82d56dd51b51748ea6000a3f2f10a2544ffd2
2 Author: Ulrich Müller <ulm <AT> gentoo <DOT> org>
3 AuthorDate: Sun Feb 26 16:33:23 2017 +0000
4 Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org>
5 CommitDate: Tue Feb 28 21:40:01 2017 +0000
6 URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=4db82d56
7
8 ebuild-writing: The ebuild header doesn't have an $Id$ line any more.
9
10 See Gentoo Council decision on 28 February 2017:
11 https://bugs.gentoo.org/611234
12
13 ebuild-writing/common-mistakes/text.xml | 15 +++++++--------
14 ebuild-writing/file-format/text.xml | 16 ++++++++++------
15 2 files changed, 17 insertions(+), 14 deletions(-)
16
17 diff --git a/ebuild-writing/common-mistakes/text.xml b/ebuild-writing/common-mistakes/text.xml
18 index e3ee42d..1981bd5 100644
19 --- a/ebuild-writing/common-mistakes/text.xml
20 +++ b/ebuild-writing/common-mistakes/text.xml
21 @@ -155,21 +155,20 @@ skel.ebuild</uri>.
22 </p>
23
24 <p>
25 -The first three lines <e>must</e> look like this:
26 +The first two lines <e>must</e> look like this:
27 </p>
28
29 <pre caption="Valid Header">
30 # Copyright 1999-2017 Gentoo Foundation
31 # Distributed under the terms of the GNU General Public License v2
32 -# &#36;Id&#36;
33 </pre>
34
35 -<p>
36 -Only if you are submitting a patched or version bumped ebuild, should you not
37 -need to modify the <c>&#36;Id&#36;</c> line. But the line must be present.
38 -It will be expanded on the staging box automatically. So there is no need for you to manually modify it.
39 -See <uri link="::general-concepts/git-to-rsync"/>.
40 -</p>
41 +<note>
42 +The header previously included a third line with a CVS <c>&#36;Id&#36;</c>
43 +or <c>&#36;Header&#36;</c> keyword. That line was abolished after conversion
44 +to Git by <uri link="https://bugs.gentoo.org/611234">decision of the Gentoo
45 +Council on 28 February 2017</uri> and <e>must not</e> be added any more.
46 +</note>
47
48 </body>
49 </subsection>
50
51 diff --git a/ebuild-writing/file-format/text.xml b/ebuild-writing/file-format/text.xml
52 index 39e2ba4..1717d27 100644
53 --- a/ebuild-writing/file-format/text.xml
54 +++ b/ebuild-writing/file-format/text.xml
55 @@ -143,19 +143,23 @@ version components.
56 <body>
57
58 <p>
59 -All ebuilds committed to the tree should have a three line header immediately at
60 +All ebuilds committed to the tree should have a two line header immediately at
61 the start indicating copyright. This must be an exact copy of the contents of
62 -<c>$(portageq get_repo_path / gentoo)/header.txt</c>. Ensure that the
63 -<c>&#36;Id&#36;</c> line is not modified manually <d/> will be expanded
64 -on staging box. See <uri link="::general-concepts/git-to-rsync"/>.
65 +<c>$(portageq get_repo_path / gentoo)/header.txt</c>.
66 </p>
67
68 <codesample lang="ebuild">
69 -# Copyright 1999-2016 Gentoo Foundation
70 +# Copyright 1999-2017 Gentoo Foundation
71 # Distributed under the terms of the GNU General Public License v2
72 -# &#36;Id&#36;
73 </codesample>
74
75 +<note>
76 +The header previously included a third line with a CVS <c>&#36;Id&#36;</c>
77 +or <c>&#36;Header&#36;</c> keyword. That line was abolished after conversion
78 +to Git by <uri link="https://bugs.gentoo.org/611234">decision of the Gentoo
79 +Council on 28 February 2017</uri> and <e>must not</e> be added any more.
80 +</note>
81 +
82 </body>
83 </section>