From: Michael Orlitzky <m...@gentoo.org> The ChangeLog section under misc-files is misleading now that our main repository has been switched to git (and we no longer have ChangeLogs). Remove the ebuild-writing/misc-files/changelog page.
X-Gentoo-Bug-URL: https://bugs.gentoo.org/show_bug.cgi?id=485314 --- ebuild-writing/misc-files/changelog/text.xml | 111 --------------------------- ebuild-writing/misc-files/text.xml | 1 - 2 files changed, 112 deletions(-) diff --git a/ebuild-writing/misc-files/changelog/text.xml b/ebuild-writing/misc-files/changelog/text.xml deleted file mode 100644 index ff68e11..0000000 --- a/ebuild-writing/misc-files/changelog/text.xml +++ /dev/null @@ -1,111 +0,0 @@ -<?xml version="1.0"?> -<guide self="ebuild-writing/misc-files/changelog/"> -<chapter> -<title>ChangeLog</title> - -<body> -<p> -The <c>ChangeLog</c> must be updated with each commit. The -<uri link="::tools-reference/echangelog/">echangelog tool</uri> should be used to create <c>ChangeLog</c> entries; -the format of a <c>ChangeLog</c> is now defined as "whatever -<c>echangelog</c> creates". -</p> - -<p> -You should include references to any relevant bugs. The standard -format for doing this is via the phrase <c>bug #20600</c> — this -format (with the hash sign included) is recognised via -<uri link="https://packages.gentoo.org";>packages.gentoo.org</uri> and -similar tools. When including user-submitted ebuilds or patches, you -should credit the user with their full name and email address (or -whatever they use to identify themselves on bugzilla <d/> some users -prefer to be known only by a nickname). -</p> - -<p> -If you are changing keywords, make sure you clearly state what -keywords you add or remove. "Marked stable" is a nuisance for -architecture teams, even if there was only one keyword in the ebuild -at the time. "Stable on all archs" isn't generally any better (and -should you really be stabling on all archs?) — do you mean "all", or -"all the ones that are currently keyworded"? A list like "x86 sparc -mips" is much more useful. -</p> - -<p> -A typical <c>ChangeLog</c> snippet might look like the following: -</p> - -<pre> - *vim-6.3.068 (25 Mar 2005) - - 25 Mar 2005; Ciaran McCreesh <ciar...@gentoo.org> +vim-6.3.068.ebuild: - New release. Fixes bug #79981, bug #81289, bug #83383, bug #83416, bug - #83565, bug #85758, upstream patches up to 6.3.068. - - 22 Mar 2005; Aron Griffis <agrif...@gentoo.org> vim-6.3-r4.ebuild: - Stable on alpha -</pre> - -<note> -If a <c>ChangeLog</c> file is not present in your current working directory, -then you should write a <c>ChangeLog</c> entry in the parent's directory -<c>ChangeLog</c> file. -</note> - -<section> -<title>Writing correct ChangeLog messages</title> -<body> -<note> -It is <b>very</b> important that your <c>cvs commit</c> messages are -also informative to aid the QA team or architecture teams as well as -other developers if they are trying to troubleshoot issues which are -known to not have occured in previous versions of ebuilds, for -example. If your ChangeLog message is concise there is usually nothing -wrong with using it as the <c>cvs commit</c> message. -</note> - -<p> -Your message should explain what specifically you changed and, if -relevant, why. You don't need to write an essay or even a complete -sentence (<c>ChangeLog</c> messages, however, are required to be in -'proper' English so no <c>fixed that bug kthx Bob</c> messages — -please do use punctuation), so long as it is easily understandable and -(preferably) greppable. Bad and good examples, all of which are based -upon real messages: -</p> - -<ul> - <li><b>BAD:</b> Changed keywords</li> - <li><e>GOOD:</e> Added ~x86 keyword</li> -</ul> - -<ul> - <li><b>BAD:</b> Stable</li> - <li><e>GOOD:</e> Stable on x86, sparc, mips</li> -</ul> - -<ul> - <li><b>BAD:</b> Fix stuff</li> - <li><e>GOOD:</e> Fix USE=foo logic error</li> -</ul> - -<ul> - <li><b>BAD:</b> .</li> - <li><e>GOOD:</e> Purge old ebuilds</li> -</ul> - -<ul> - <li> - <b>BAD:</b> Who the fuck reads this anyway? (<b>Editor's note</b>: - No, seriously, this is a genuine example. Do <e>not</e> do - this...) - </li> - <li><e>GOOD:</e> Version bump to 0.5.1.</li> -</ul> - -</body> -</section> -</body> -</chapter> -</guide> diff --git a/ebuild-writing/misc-files/text.xml b/ebuild-writing/misc-files/text.xml index 31f1421..416070b 100644 --- a/ebuild-writing/misc-files/text.xml +++ b/ebuild-writing/misc-files/text.xml @@ -18,6 +18,5 @@ This section contains some notes on various miscellaneous files. </chapter> <include href="metadata/"/> -<include href="changelog/"/> <include href="patches/"/> </guide> -- 2.4.10
