| 1 |
commit: 4ece0aa606656792178aa576a5c2e82ed45fb048 |
| 2 |
Author: Michał Górny <mgorny <AT> gentoo <DOT> org> |
| 3 |
AuthorDate: Sun Aug 4 05:13:30 2019 +0000 |
| 4 |
Commit: Göktürk Yüksek <gokturk <AT> gentoo <DOT> org> |
| 5 |
CommitDate: Fri Aug 30 15:49:22 2019 +0000 |
| 6 |
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=4ece0aa6 |
| 7 |
|
| 8 |
eclass-writing: Word review requirement more strongly |
| 9 |
|
| 10 |
Make the review of eclass updates an explicit requirement rather than |
| 11 |
strong suggestion. Require them unconditionally, providing explicit |
| 12 |
exception for per-package eclasses. |
| 13 |
|
| 14 |
Signed-off-by: Michał Górny <mgorny <AT> gentoo.org> |
| 15 |
|
| 16 |
eclass-writing/text.xml | 22 +++++++++++----------- |
| 17 |
1 file changed, 11 insertions(+), 11 deletions(-) |
| 18 |
|
| 19 |
diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml |
| 20 |
index ee7d5d0..011a3d5 100644 |
| 21 |
--- a/eclass-writing/text.xml |
| 22 |
+++ b/eclass-writing/text.xml |
| 23 |
@@ -53,12 +53,17 @@ does not require a new eclass will be suggested. |
| 24 |
</p> |
| 25 |
|
| 26 |
<p> |
| 27 |
-Before updating <c>eutils</c> or a similar widely used eclass, it is best to email |
| 28 |
-the gentoo-dev list. It may be that your proposed change is broken in a way you |
| 29 |
-had not anticipated, or that there is an existing function which performs the |
| 30 |
-same purpose, or that your function may be better off in its own eclass. If you |
| 31 |
-don't email gentoo-dev first, and end up breaking something, expect to be in a |
| 32 |
-lot of trouble. |
| 33 |
+Before updating any eclass, email patches to the gentoo-dev list. It may be that |
| 34 |
+your proposed change is broken in a way you had not anticipated, or that there |
| 35 |
+is an existing function which performs the same purpose, or that your function |
| 36 |
+may be better off in its own eclass. If you don't email gentoo-dev first, |
| 37 |
+and end up breaking something, expect to be in a lot of trouble. |
| 38 |
+</p> |
| 39 |
+ |
| 40 |
+<p> |
| 41 |
+The exceptions to this rule are per-package eclasses. For example, |
| 42 |
+the <c>apache-2</c> eclass is only used by the <c>www-servers/apache</c> |
| 43 |
+package, and thus does not typically require changes to be emailed for review. |
| 44 |
</p> |
| 45 |
|
| 46 |
<p> |
| 47 |
@@ -73,11 +78,6 @@ If there is an existing maintainer for an eclass (this is usually the case), you |
| 48 |
<b>must</b> talk to the maintainer before committing any changes. |
| 49 |
</p> |
| 50 |
|
| 51 |
-<p> |
| 52 |
-It is not usually necessary to email the gentoo-dev list before making changes |
| 53 |
-to a non-general eclass which you maintain. Use common sense here. |
| 54 |
-</p> |
| 55 |
- |
| 56 |
<warning> |
| 57 |
Committing a broken eclass can kill huge numbers of packages. Since |
| 58 |
<c>repoman</c> is not eclass-aware, be very sure you do proper testing. |
Archives