r44002 - /website/changelog.pod

nhandler-guest at users.alioth.debian.org nhandler-guest at users.alioth.debian.org
Sun Sep 13 01:23:25 UTC 2009


Author: nhandler-guest
Date: Sun Sep 13 01:23:18 2009
New Revision: 44002

URL: http://svn.debian.org/wsvn/?sc=1&rev=44002
Log:
Add initial rough draft of changelog.pod

Added:
    website/changelog.pod

Added: website/changelog.pod
URL: http://svn.debian.org/wsvn/website/changelog.pod?rev=44002&op=file
==============================================================================
--- website/changelog.pod (added)
+++ website/changelog.pod Sun Sep 13 01:23:18 2009
@@ -1,0 +1,71 @@
+=head1 NAME
+
+changelog - Debian Perl Group changelog header information
+
+=head1 INTRODUCTION
+
+This is a small guide detailing some common headers that are used in changelog
+files. These headers are used by PET (
+L<http://pkg-perl.alioth.debian.org/cgi-bin/pet.cgi>
+) in order to properly track the status of the package.
+
+Contributions are welcomed. PET is constantly being updated, and new headers
+are still being added. A list of proposed headers is available at
+L<http://wiki.debian.org/Teams/DebianPerlGroup/OpenTasks/ChangelogHeaders>
+
+=head1 UNRELEASED
+
+C<UNRELEASED> is not a real header. Until a package is ready for upload, the
+distribution is set to C<UNRELEASED> so that everyone is able to quickly see that
+this new version of the package has not been uploaded yet. It is also allows
+potential sponsors to know that the package is not ready to be uploaded. Once
+the package is complete and ready for upload, the distribution should be set to
+unstable or whatever distribution the package is intended for.
+
+=head1 IGNORE-VERSION
+
+Sometimes, upstream might release a new version of a package that does not need
+to be uploaded in Debian. One reason for this would be if the changes are very
+minor, or if the changes do not apply to Debian. C<IGNORE-VERSION> can be used
+to make PET aware of this. C<IGNORE-VERSION> takes a version as an argument.
+
+=head2 Example
+
+C<IGNORE-VERSION: 0.34-5>
+
+This line, if included in a changelog entry, will tell PET that there is no need
+to upload version 0.34-5 of the package.
+
+=head1 WAITS-FOR
+
+In some situtations, a package might fail to build from source (FTBFS) due to
+being unable to satisfy all of its Build-Depends. The C<WAITS-FOR> header can be
+used to tell PET that the package is ready, but is waiting on another package to
+be uploaded to the archives first. A version can also be passed to C<WAITS-FOR>.
+If a version is given, the waited for package shall be of greater or equal
+version.
+
+=head2 Example
+
+C<WAITS-FOR: foo>
+
+This line will tell PET that this package is ready, but it is waiting on C<foo>
+to be uploaded.
+
+C<WAITS-FOR: foo 1.23-4>
+
+This line, like the previous example, will tell PET that this package is ready,
+but it is waiting on C<foo> to be uploaded. However, this line will have PET
+wait until a version greater than or equal to 1.23-4 of C<foo> is uploaded.
+
+=head1 CONTRIBUTORS
+
+The following people have contributed to the maintainership of this file:
+
+=over
+
+=item * Nathan Handler <nhandler at ubuntu.com>
+
+=back
+
+=cut




More information about the Pkg-perl-cvs-commits mailing list