On Mon, 03 Dec 2007 20:51:47 +0100, gregor herrmann wrote:
> > Some corrections in a sort of wdiff:
[..]
> Sounds good to me, the rest are editorial changes that can IMO left
> to whoever fires up $EDITOR policy.pod :)
It was me who did :)
I've tried to put the discussed changes into policy.pod and also
edited some other parts (simple corrections, slight re-phrasements; I
hope I got all not gender-neutral parts, too [0]).
I've committed the draft for the changed version as
website/policy.pod.draft to our svn repo [1], and I'm attaching the
output of wdiff and diff -u for convenience.
Please comment here (or improve the draft in the repo).
Cheers,
gregor
[0]
I've often used direct speech ("you have to") which was already used
in some other paragraphs.
[1]
Also accessible at http://pkg-perl.alioth.debian.org/policy.pod.draft
--
.''`. http://info.comodo.priv.at/ | gpg key ID: 0x00F3CFE4
: :' : debian: the universal operating system - http://www.debian.org/
`. `' member of https://www.vibe.at/ | how to reply: http://got.to/quote/
`-
--- policy.pod 2007-10-17 23:16:57.000000000 +0200 +++ policy.pod.draft 2007-12-05 19:46:47.000000000 +0100 @@ -6,11 +6,11 @@ Project Internal Policy -Here we document how we do stuff internally. This file is of course work in +This document describes how we do stuff internally. It is of course work in progress and will probably always be. We are using a subversion repository to keep the packages under revision -control. It is recommended that you read Debian Perl Group Subversion +control. It is recommended that you read the Debian Perl Group Subversion Guide (L<http://pkg-perl.alioth.debian.org/subversion.html>) to see how our repository should be used, it is out of scope of this document. @@ -24,11 +24,13 @@ =item 3. L<debian/control handling|/"debian/control handling"> -=item 4. L<Release Process|/"Release Process"> +=item 4. L<Debian Maintainers practice|/"Debian Maintainers practice"> -=item 5. L<Authors|/"Authors"> +=item 5. L<Release Process|/"Release Process"> -=item 6. L<License|/"License"> +=item 6. L<Authors|/"Authors"> + +=item 7. L<License|/"License"> =back @@ -55,27 +57,28 @@ you add another debian/changelog entry (dch -i). Since your name and e-mail will then be in there, you have to check that you are listed in Uploaders: in debian/control (otherwise katie or whoever will think that you are doing -a NMU). +an NMU), if you actually plan to upload the package (i.e. if you are a DD or a DM +allowed to upload the specific package). -If someone else changed something that has to be noted in debian/changelog, -he just adds a line to the current entry (dch -a). He should not put his -name there - the user does not care and we can always check the svn log. +If you change something that has to be noted in debian/changelog, just add a +line to the current entry (dch -a). The [firstname lastname] markers added by +dch are okay to give credit to non-upload-permitted contributors. + +Important NOTES to other group members may be placed at the top of the current +changelog entry of packages that are not yet ready for upload (e.g. why a +package is still UNRELEASED etc.). =head1 debian/control handling -Before importing a package into the SVN repository for the first time -you should change the Maintainer field to -pkg-perl-maintainers@lists.alioth.debian.org. You should put your own -email address and name in the Uploaders field. If there are others -that you know of who will be modifying the package in the future, you -should add their name and email address to the Uploaders field as -well. - -When modifying a package in the repository, you should add your name -to the Uploaders file. You should keep the names of other maintainers -who added their name before you. In other words, the Uploaders field -must be updated to contain everyone that worked on the package. The -Maintainer field must remain unchanged after the first import. +When importing a package into the SVN repository for the first time change the +Maintainer field to "Debian Perl Group +E<lt>pkg-perl-maintainers@lists.alioth.debian.orgE<gt>" and put your own email +address and name in the Uploaders field, if you plan to actually upload the +package. + +When you modify a package in the repository and plan to upload it, add your +name to the Uploaders field. You should keep the names of other DDs and DMs who +added their names before you. The packages maintained by the group should contain the following fields: @@ -92,50 +95,109 @@ =item Maintainer All group-maintained packages should list -pkg-perl-maintainers@lists.alioth.debian.org as the main maintainer +I<"Debian Perl Group E<lt>pkg-perl-maintainers@lists.alioth.debian.orgE<gt>"> +as the maintainer. =item Uploaders -List yourself in this field - Every person interested in co-maintaining this -package should be listed as an uploader. +Contains the list of contributors with upload rights. That is, all DDs that +were working on or have uploaded the package at some point, plus all DMs that +are allowed to upload it. =item Vcs-Svn -An URL pointing to the package's base location in our repository - That +An URL pointing to the package's base location in our repository. That is, for a package called I<libsomething-perl>, -L<svn://svn.debian.org/pkg-perl/trunk/libsomething-perl/> +L<svn://svn.debian.org/pkg-perl/trunk/libsomething-perl/>. =item Vcs-Browser An URL pointing to the public Web interface where this package's base location -in the repository can be browsed. for I<libsomething-perl>, it would be -L<http://svn.debian.org/wsvn/pkg-perl/trunk/libsomething-perl/> +in the repository can be browsed. For I<libsomething-perl>, it would be +L<http://svn.debian.org/wsvn/pkg-perl/trunk/libsomething-perl/>. =item Homepage The URL for this module's upstream homepage. For CPAN modules, unless the -author has a specific homepage, you can point at -I<http://search.cpan.org/dist/Something/> +author has a specific homepage, you can point to +L<http://search.cpan.org/dist/Something/>. =back -The other usual fields should, of course, be present and with sensible values. -Particularly, try to stick to the highest published standards-version and +The other usual fields should, of course, be present and have sensible values. +Particularly, try to stick to the highest published Standards-Version and debhelper compatibility level. The pkg-perl group members prefer to directly use debhelper when packaging. We -suggest you not to use cdbs as part of the build process for packages intended +suggest you don't use cdbs as part of the build process for packages intended to be group-maintained. +=head1 Debian Maintainers practice + +This section describes briefly how the Debian Maintainers concecpt (cf. +L<http://www.debian.org/vote/2007/vote_003>) is handled in the pkg-perl group. + +=head2 1. DM actions + +As a DM you prepare a new (upstream/debian) version of the package and want it +uploaded. You are also confident in working with the package and want to be +able to upload it in the future. You have to do four things: + +=over + +=item * + +add yourself to Uploaders + +=item * + +add XS-DM-Upload-Allowed: yes (if it's not yet there) + +=item * + +document both above changes in debian/changelog as usual + +=item * + +add an explicit note to the top of debian/changelog (in such a manner that it +can't be missed by the sponsor) warning of the changes + +=back + +=head2 2. DD actions + +The sponsoring DD decides, removes the note, and + +=over + +=item * + +either accepts the request, cleans Uploaders and uploads the package + +=item * + +or denies the request, undoes upload-permission-giving changes (Uploaders +and/or XS-DM-Upload-Allowed), and uploads as before + +=back + +In both cases a mail should be sent to debian-perl@lists.debian.org. + +=head2 3. Note + +Although technically possible DMs are not allowed to add other DMs to a +package. + =head1 Release Process -If you are a full DD, upload but be prepared to receive (at least parts of) the +If you are a DD or a DM who has been granted the right to upload the package +in question, upload but be prepared to receive (at least parts of) the blame. If you are not, some DD in the Group will surely sponsor the package. They will check the package first, too, but make sure there is no reason to complain. If you have a package ready for upload, just ask at debian-perl@lists.debian.org or in the channel #debian-perl at irc.debian.org -Always feel free to ask other to check a package if in doubt. +Always feel free to ask others to check a package if in doubt. =head1 VERSION @@ -168,5 +230,3 @@ complete text of the GNU General Public License can be found in `/usr/share/common-licenses/GPL' and the Artistic License in `/usr/share/common-licenses/Artistic'. - -
=head1 NAME
Debian Perl Group Policy
=head1 INTRODUCTION
Project Internal Policy
[-Here we-]
{+This+} document {+describes+} how we do stuff internally. [-This file-] {+It+} is of course work in
progress and will probably always be.
We are using a subversion repository to keep the packages under revision
control. It is recommended that you read {+the+} Debian Perl Group Subversion
Guide (L<http://pkg-perl.alioth.debian.org/subversion.html>) to see how our
repository should be used, it is out of scope of this document.
=head1 INDEX
=over 4
=item 1. L<Mandatory mailing lists and such|/"Mandatory mailing lists and such">
=item 2. L<debian/changelog handling and versioning|/"debian/changelog handling and versioning">
=item 3. L<debian/control handling|/"debian/control handling">
=item 4. {+L<Debian Maintainers practice|/"Debian Maintainers practice">
=item 5.+} L<Release Process|/"Release Process">
=item [-5.-] {+6.+} L<Authors|/"Authors">
=item [-6.-] {+7.+} L<License|/"License">
=back
=head1 Mandatory mailing lists and such
All members of our group should be subscribed to debian-perl@lists.debian.org
and read this list (at least skim all messages for Debian Perl Group related
stuff). Additionally, every member should be subscribed to
pkg-perl-maintainers@lists.alioth.debian.org to receive bug reports and
similar information.
All members are encouraged to have all our packages installed. They are also
encouraged to check our webspace (L<http://alioth.debian.org/projects/pkg-perl>),
and our svn repository (L<http://svn.debian.org/wsvn/pkg-perl/>). You can
watch the work on our svn repository subscribing to our svn commits
list (L<http://alioth.debian.org/mail/?group_id=30274>), listed there as
pkg-perl-cvs-commits. The commit messages are also sent to #debian-perl
at irc.debian.org.
=head1 debian/changelog handling and versioning
We use the debian revision to count our releases to the debian archive, not
internal steps. So if and only if you do the first change after a release,
you add another debian/changelog entry (dch -i). Since your name and e-mail
will then be in there, you have to check that you are listed in Uploaders:
in debian/control (otherwise katie or whoever will think that you are doing
{+an NMU), if you actually plan to upload the package (i.e. if you are+} a [-NMU).-] {+DD or a DM
allowed to upload the specific package).+}
If [-someone else changed-] {+you change+} something that has to be noted in debian/changelog,
[-he-] just [-adds-] {+add+} a
line to the current entry (dch -a). [-He should not put his
name there --] {+The [firstname lastname] markers added by
dch are okay to give credit to non-upload-permitted contributors.
Important NOTES to other group members may be placed at+} the [-user does not care and we can always check-] {+top of+} the [-svn log.-] {+current
changelog entry of packages that are not yet ready for upload (e.g. why a
package is still UNRELEASED etc.).+}
=head1 debian/control handling
[-Before-]
{+When+} importing a package into the SVN repository for the first time
[-you should-] change the
Maintainer field to
[-pkg-perl-maintainers@lists.alioth.debian.org. You should-] {+"Debian Perl Group
E<lt>pkg-perl-maintainers@lists.alioth.debian.orgE<gt>" and+} put your own email
address and name in the Uploaders [-field. If there are others
that you know of who will be modifying the package in the future,-] {+field, if+} you
[-should add their name and email address-] {+plan+} to {+actually upload+} the [-Uploaders field as
well.-]
{+package.+}
When [-modifying-] {+you modify+} a package in the [-repository, you should-] {+repository and plan to upload it,+} add your
name to the Uploaders [-file.-] {+field.+} You should keep the names of other [-maintainers-] {+DDs and DMs+} who
added their [-name-] {+names+} before you. [-In other words, the Uploaders field
must be updated to contain everyone that worked on the package. The
Maintainer field must remain unchanged after the first import.-]
The packages maintained by the group should contain the following fields:
=over
=item Section
Perl packages should be uploaded to the I<perl> section.
=item Priority
Most Perl packages should be of priority I<optional>.
=item Maintainer
All group-maintained packages should list
[-pkg-perl-maintainers@lists.alioth.debian.org-]
{+I<"Debian Perl Group E<lt>pkg-perl-maintainers@lists.alioth.debian.orgE<gt>">+}
as the [-main maintainer-] {+maintainer.+}
=item Uploaders
[-List yourself in this field - Every person interested in co-maintaining this-]
{+Contains the list of contributors with upload rights. That is, all DDs that
were working on or have uploaded the+} package [-should be listed as an uploader.-] {+at some point, plus all DMs that
are allowed to upload it.+}
=item Vcs-Svn
An URL pointing to the package's base location in our [-repository --] {+repository.+} That
is, for a package called I<libsomething-perl>,
[-L<svn://svn.debian.org/pkg-perl/trunk/libsomething-perl/>-]
{+L<svn://svn.debian.org/pkg-perl/trunk/libsomething-perl/>.+}
=item Vcs-Browser
An URL pointing to the public Web interface where this package's base location
in the repository can be browsed. [-for-] {+For+} I<libsomething-perl>, it would be
[-L<http://svn.debian.org/wsvn/pkg-perl/trunk/libsomething-perl/>-]
{+L<http://svn.debian.org/wsvn/pkg-perl/trunk/libsomething-perl/>.+}
=item Homepage
The URL for this module's upstream homepage. For CPAN modules, unless the
author has a specific homepage, you can point [-at
I<http://search.cpan.org/dist/Something/>-] {+to
L<http://search.cpan.org/dist/Something/>.+}
=back
The other usual fields should, of course, be present and [-with-] {+have+} sensible values.
Particularly, try to stick to the highest published [-standards-version-] {+Standards-Version+} and
debhelper compatibility level.
The pkg-perl group members prefer to directly use debhelper when packaging. We
suggest you [-not to-] {+don't+} use cdbs as part of the build process for packages intended
to be group-maintained.
=head1 {+Debian Maintainers practice
This section describes briefly how the Debian Maintainers concecpt (cf.
L<http://www.debian.org/vote/2007/vote_003>) is handled in the pkg-perl group.
=head2 1. DM actions
As a DM you prepare a new (upstream/debian) version of the package and want it
uploaded. You are also confident in working with the package and want to be
able to upload it in the future. You have to do four things:
=over
=item *
add yourself to Uploaders
=item *
add XS-DM-Upload-Allowed: yes (if it's not yet there)
=item *
document both above changes in debian/changelog as usual
=item *
add an explicit note to the top of debian/changelog (in such a manner that it
can't be missed by the sponsor) warning of the changes
=back
=head2 2. DD actions
The sponsoring DD decides, removes the note, and
=over
=item *
either accepts the request, cleans Uploaders and uploads the package
=item *
or denies the request, undoes upload-permission-giving changes (Uploaders
and/or XS-DM-Upload-Allowed), and uploads as before
=back
In both cases a mail should be sent to debian-perl@lists.debian.org.
=head2 3. Note
Although technically possible DMs are not allowed to add other DMs to a
package.
=head1+} Release Process
If you are a [-full DD,-] {+DD or a DM who has been granted the right to upload the package
in question,+} upload but be prepared to receive (at least parts of) the
blame. If you are not, some DD in the Group will surely sponsor the package. They
will check the package first, too, but make sure there is no reason to complain.
If you have a package ready for upload, just ask at debian-perl@lists.debian.org
or in the channel #debian-perl at irc.debian.org
Always feel free to ask [-other-] {+others+} to check a package if in doubt.
=head1 VERSION
$Id: policy.pod 8325 2007-10-17 21:16:58Z gregoa-guest $
=head1 AUTHORS
=over
=item * Joachim Breitner
=item * Daniel Ruoso
=item * Gustavo Franco
=item * Gunnar Wolf
=item * Gregor Herrmann
=back
=head1 LICENSE
Copyright (c) 2004-2007 Debian Perl Group. All rights reserved. This document is
free software; you may redistribute it and/or modify it under the same
terms as Perl itself
Perl is distributed under your choice of the GNU General Public
License or the Artistic License. On Debian GNU/Linux systems, the
complete text of the GNU General Public License can be found in
`/usr/share/common-licenses/GPL' and the Artistic License in
`/usr/share/common-licenses/Artistic'.
Attachment:
signature.asc
Description: Digital signature