| 1 |
From: Michael Orlitzky <mjo@g.o> |
| 2 |
|
| 3 |
The ChangeLog section under misc-files is misleading now that our main |
| 4 |
repository has been switched to git (and we no longer have |
| 5 |
ChangeLogs). Remove the ebuild-writing/misc-files/changelog page. |
| 6 |
|
| 7 |
X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=485314 |
| 8 |
--- |
| 9 |
ebuild-writing/misc-files/changelog/text.xml | 111 --------------------------- |
| 10 |
ebuild-writing/misc-files/text.xml | 1 - |
| 11 |
2 files changed, 112 deletions(-) |
| 12 |
|
| 13 |
diff --git a/ebuild-writing/misc-files/changelog/text.xml b/ebuild-writing/misc-files/changelog/text.xml |
| 14 |
deleted file mode 100644 |
| 15 |
index ff68e11..0000000 |
| 16 |
--- a/ebuild-writing/misc-files/changelog/text.xml |
| 17 |
+++ /dev/null |
| 18 |
@@ -1,111 +0,0 @@ |
| 19 |
-<?xml version="1.0"?> |
| 20 |
-<guide self="ebuild-writing/misc-files/changelog/"> |
| 21 |
-<chapter> |
| 22 |
-<title>ChangeLog</title> |
| 23 |
- |
| 24 |
-<body> |
| 25 |
-<p> |
| 26 |
-The <c>ChangeLog</c> must be updated with each commit. The |
| 27 |
-<uri link="::tools-reference/echangelog/">echangelog tool</uri> should be used to create <c>ChangeLog</c> entries; |
| 28 |
-the format of a <c>ChangeLog</c> is now defined as "whatever |
| 29 |
-<c>echangelog</c> creates". |
| 30 |
-</p> |
| 31 |
- |
| 32 |
-<p> |
| 33 |
-You should include references to any relevant bugs. The standard |
| 34 |
-format for doing this is via the phrase <c>bug #20600</c> — this |
| 35 |
-format (with the hash sign included) is recognised via |
| 36 |
-<uri link="https://packages.gentoo.org">packages.gentoo.org</uri> and |
| 37 |
-similar tools. When including user-submitted ebuilds or patches, you |
| 38 |
-should credit the user with their full name and email address (or |
| 39 |
-whatever they use to identify themselves on bugzilla <d/> some users |
| 40 |
-prefer to be known only by a nickname). |
| 41 |
-</p> |
| 42 |
- |
| 43 |
-<p> |
| 44 |
-If you are changing keywords, make sure you clearly state what |
| 45 |
-keywords you add or remove. "Marked stable" is a nuisance for |
| 46 |
-architecture teams, even if there was only one keyword in the ebuild |
| 47 |
-at the time. "Stable on all archs" isn't generally any better (and |
| 48 |
-should you really be stabling on all archs?) — do you mean "all", or |
| 49 |
-"all the ones that are currently keyworded"? A list like "x86 sparc |
| 50 |
-mips" is much more useful. |
| 51 |
-</p> |
| 52 |
- |
| 53 |
-<p> |
| 54 |
-A typical <c>ChangeLog</c> snippet might look like the following: |
| 55 |
-</p> |
| 56 |
- |
| 57 |
-<pre> |
| 58 |
- *vim-6.3.068 (25 Mar 2005) |
| 59 |
- |
| 60 |
- 25 Mar 2005; Ciaran McCreesh <ciaranm@g.o> +vim-6.3.068.ebuild: |
| 61 |
- New release. Fixes bug #79981, bug #81289, bug #83383, bug #83416, bug |
| 62 |
- #83565, bug #85758, upstream patches up to 6.3.068. |
| 63 |
- |
| 64 |
- 22 Mar 2005; Aron Griffis <agriffis@g.o> vim-6.3-r4.ebuild: |
| 65 |
- Stable on alpha |
| 66 |
-</pre> |
| 67 |
- |
| 68 |
-<note> |
| 69 |
-If a <c>ChangeLog</c> file is not present in your current working directory, |
| 70 |
-then you should write a <c>ChangeLog</c> entry in the parent's directory |
| 71 |
-<c>ChangeLog</c> file. |
| 72 |
-</note> |
| 73 |
- |
| 74 |
-<section> |
| 75 |
-<title>Writing correct ChangeLog messages</title> |
| 76 |
-<body> |
| 77 |
-<note> |
| 78 |
-It is <b>very</b> important that your <c>cvs commit</c> messages are |
| 79 |
-also informative to aid the QA team or architecture teams as well as |
| 80 |
-other developers if they are trying to troubleshoot issues which are |
| 81 |
-known to not have occured in previous versions of ebuilds, for |
| 82 |
-example. If your ChangeLog message is concise there is usually nothing |
| 83 |
-wrong with using it as the <c>cvs commit</c> message. |
| 84 |
-</note> |
| 85 |
- |
| 86 |
-<p> |
| 87 |
-Your message should explain what specifically you changed and, if |
| 88 |
-relevant, why. You don't need to write an essay or even a complete |
| 89 |
-sentence (<c>ChangeLog</c> messages, however, are required to be in |
| 90 |
-'proper' English so no <c>fixed that bug kthx Bob</c> messages — |
| 91 |
-please do use punctuation), so long as it is easily understandable and |
| 92 |
-(preferably) greppable. Bad and good examples, all of which are based |
| 93 |
-upon real messages: |
| 94 |
-</p> |
| 95 |
- |
| 96 |
-<ul> |
| 97 |
- <li><b>BAD:</b> Changed keywords</li> |
| 98 |
- <li><e>GOOD:</e> Added ~x86 keyword</li> |
| 99 |
-</ul> |
| 100 |
- |
| 101 |
-<ul> |
| 102 |
- <li><b>BAD:</b> Stable</li> |
| 103 |
- <li><e>GOOD:</e> Stable on x86, sparc, mips</li> |
| 104 |
-</ul> |
| 105 |
- |
| 106 |
-<ul> |
| 107 |
- <li><b>BAD:</b> Fix stuff</li> |
| 108 |
- <li><e>GOOD:</e> Fix USE=foo logic error</li> |
| 109 |
-</ul> |
| 110 |
- |
| 111 |
-<ul> |
| 112 |
- <li><b>BAD:</b> .</li> |
| 113 |
- <li><e>GOOD:</e> Purge old ebuilds</li> |
| 114 |
-</ul> |
| 115 |
- |
| 116 |
-<ul> |
| 117 |
- <li> |
| 118 |
- <b>BAD:</b> Who the fuck reads this anyway? (<b>Editor's note</b>: |
| 119 |
- No, seriously, this is a genuine example. Do <e>not</e> do |
| 120 |
- this...) |
| 121 |
- </li> |
| 122 |
- <li><e>GOOD:</e> Version bump to 0.5.1.</li> |
| 123 |
-</ul> |
| 124 |
- |
| 125 |
-</body> |
| 126 |
-</section> |
| 127 |
-</body> |
| 128 |
-</chapter> |
| 129 |
-</guide> |
| 130 |
diff --git a/ebuild-writing/misc-files/text.xml b/ebuild-writing/misc-files/text.xml |
| 131 |
index 31f1421..416070b 100644 |
| 132 |
--- a/ebuild-writing/misc-files/text.xml |
| 133 |
+++ b/ebuild-writing/misc-files/text.xml |
| 134 |
@@ -18,6 +18,5 @@ This section contains some notes on various miscellaneous files. |
| 135 |
</chapter> |
| 136 |
|
| 137 |
<include href="metadata/"/> |
| 138 |
-<include href="changelog/"/> |
| 139 |
<include href="patches/"/> |
| 140 |
</guide> |
| 141 |
-- |
| 142 |
2.4.10 |
Archives