aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorUlrich Müller <ulm@gentoo.org>2005-07-12 17:21:19 +0000
committerUlrich Müller <ulm@gentoo.org>2020-01-09 23:50:51 +0100
commitb5eb706b0d006535cb8e48b7a03177249a630dd0 (patch)
treebd1ad55b9d89bbe5b185210eb838759e4aa4923e /ebuild-writing/misc-files/changelog/text.rst
downloaddevmanual-b5eb706b0d006535cb8e48b7a03177249a630dd0.tar.gz
devmanual-b5eb706b0d006535cb8e48b7a03177249a630dd0.tar.bz2
devmanual-b5eb706b0d006535cb8e48b7a03177249a630dd0.zip
reStructuredText source of the devmanual
Taken from ~sekretarz/public_html/devmanual.tar.bz on dev.gentoo.org and removed all generated HTML, PNG, and temporary files. Timestamp of oldest file: 2005-06-04 11:50:45 +0000 Timestamp of newest file: 2005-07-12 17:21:19 +0000 Signed-off-by: Ulrich Müller <ulm@gentoo.org>
Diffstat (limited to 'ebuild-writing/misc-files/changelog/text.rst')
-rw-r--r--ebuild-writing/misc-files/changelog/text.rst23
1 files changed, 23 insertions, 0 deletions
diff --git a/ebuild-writing/misc-files/changelog/text.rst b/ebuild-writing/misc-files/changelog/text.rst
new file mode 100644
index 0000000..c54eff8
--- /dev/null
+++ b/ebuild-writing/misc-files/changelog/text.rst
@@ -0,0 +1,23 @@
+ChangeLog
+=========
+
+.. _echangelog: ..
+
+The ``ChangeLog`` should be used to record all non-trivial changes to ebuilds,
+*including keywording changes*. The `echangelog`_ tool should be used to create
+``ChangeLog`` entries -- the format of a ``ChangeLog`` is now defined as
+"whatever ``echangelog`` creates".
+
+You should include references to any relevant bugs. The standard format for
+doing this is via the phrase ``bug #20600`` -- this format (with the hash sign
+included) is recognised via `packages.gentoo.org <http://packages.gentoo.org/>`_
+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 -- some users prefer to be known only by a
+nickname).
+
+A typical ``ChangeLog`` snippet might look like the following:
+
+.. CODESAMPLE changelog
+
+.. vim: set ft=glep tw=80 sw=4 et spell spelllang=en : ..