[med-svn] r1847 - trunk/community/website/docs
plessy at alioth.debian.org
plessy at alioth.debian.org
Sat May 10 11:14:32 UTC 2008
Author: plessy
Date: 2008-05-10 11:14:31 +0000 (Sat, 10 May 2008)
New Revision: 1847
Modified:
trunk/community/website/docs/policy.xml
Log:
Policy changes according to the discussion archived in: http://lists.debian.org/debian-med/2008/04/msg00035.html
Modified: trunk/community/website/docs/policy.xml
===================================================================
--- trunk/community/website/docs/policy.xml 2008-05-10 04:33:36 UTC (rev 1846)
+++ trunk/community/website/docs/policy.xml 2008-05-10 11:14:31 UTC (rev 1847)
@@ -1,33 +1,46 @@
-<?xml version="1.0"?>
-<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V5.0CR7//EN" "http://www.docbook.org/xml/5.0CR7/dtd/docbook.dtd">
-<article xmlns="http://docbook.org/ns/docbook" xml:base="http://debian-med.alioth.debian.org/">
+<?xml version='1.0' encoding='UTF-8'?>
+<?xml-stylesheet type="text/xsl"
+ href="http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl"?>
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
+<article xml:base="http://debian-med.alioth.debian.org/">
<title>Debian-Med Group Policy</title>
- <info>
+ <articleinfo>
<authorgroup>
<author>
- <personname>Andreas Tille</personname>
+ <firstname>Andreas</firstname>
+ <surname>Tille</surname>
+ <contrib>First review </contrib>
<email>tille at debian.org</email>
- <contrib>First review </contrib>
</author>
<author>
- <personname>David Paleino</personname>
+ <firstname>David</firstname>
+ <surname>Paleino</surname>
+ <contrib>Initial writing </contrib>
<email>d.paleino at gmail.com</email>
- <contrib>Initial writing </contrib>
</author>
+ <author>
+ <firstname>Charles</firstname>
+ <surname>Plessy</surname>
+ <contrib>Contributions in 2008</contrib>
+ <email>plessy at debian.org</email>
+ </author>
</authorgroup>
<releaseinfo>
$ policy.xml rev. @REV@ - @DATE@ (@AUTHOR@) $
</releaseinfo>
- </info>
+ </articleinfo>
<mediaobject>
- <alt>Debian-Med Group</alt>
+ <objectinfo>
+ <title>Debian-Med Group</title>
+ </objectinfo>
<imageobject>
<imagedata fileref="/img/debian-med.jpg" format="JPG" align="center" />
</imageobject>
</mediaobject>
<sect1>
<title>Introduction</title>
- <para>Debian-Med is a "<link xlink:href="http://people.debian.org/~tille/cdd">Custom Debian Distribution</link>"
+ <para>Debian-Med is a <quote><ulink url="http://people.debian.org/~tille/cdd">Custom Debian Distribution</ulink></quote>
with the aim to develop Debian into an operating system that is particularly
well fit for the requirements for medical practice and research.</para>
<para>The Debian-Med project presents packages that are associated
@@ -50,15 +63,15 @@
are fixed, if possible in collaboration with the upstream maintainer(s).
All this work would not be very useful if it remains confidential.</para>
<para>We also dedicate some time to advertise it to the world via
- <link xlink:href="http://www.debian.org">www.debian.org</link>
+ <ulink url="http://www.debian.org">www.debian.org</ulink>
and to ease the integration of new members.</para>
- <para>Please contact us on <link xlink:href="mailto:debian-med at lists.debian.org">debian-med at lists.debian.org</link>
+ <para>Please contact us on <ulink url="mailto:debian-med at lists.debian.org">debian-med at lists.debian.org</ulink>
if you want to help to make medical and biological software available
- to Debian users. Read the <link>Membership</link> section if you're
+ to Debian users. Read the <link linkend="membership">Membership</link> section if you're
interested in joining us.</para>
<para>If you speak a language other than English, you can contribute
rightaway with translations of package descriptions at
- <link xlink:href="http://ddtp.debian.org">ddtp.debian.org</link>.</para>
+ <ulink url="http://ddtp.debian.org">ddtp.debian.org</ulink>.</para>
<para>When working on these, you will find immediate targets for improvements
of the original English versions, too. For these, though, you need access
to Debian-Med's source code repository. Very welcome are tutorials that
@@ -66,22 +79,22 @@
You may also consider to write respective articles for Magazines, be they
online or in print.</para>
<sect2>
- <title>Membership</title>
+ <title id="membership">Membership</title>
<para>To request membership to this group, please go on our
- <link xlink:href="http://alioth.debian.org/projects/debian-med">Alioth page</link>,
- or directly follow this <link xlink:href="http://alioth.debian.org/project/request.php?group_id=30063">link</link>.
+ <ulink url="http://alioth.debian.org/projects/debian-med">Alioth page</ulink>,
+ or directly follow this <ulink url="http://alioth.debian.org/project/request.php?group_id=30063">link</ulink>.
Remember that you must have an Alioth account before requesting
- membership (see <link xlink:href="http://alioth.debian.org/account/register.php">here</link>
+ membership (see <ulink url="http://alioth.debian.org/account/register.php">here</ulink>
to request an Alioth account).</para>
</sect2>
</sect1>
<sect1>
<title>Subversion</title>
<para>Our Subversion (SVN) repository is currently hosted on
- <link xlink:href="http://alioth.debian.org/">Alioth</link>, the hosting
+ <ulink url="http://alioth.debian.org/">Alioth</ulink>, the hosting
facility provided by Debian to free software developers. You can have a look at
- the repository through Alioth's <link xlink:href="http://svn.debian.org/wsvn/debian-med/trunk/?rev=0&sc=0">web</link>
- <link xlink:href="http://svn.debian.org/viewsvn/debian-med">interfaces</link>.</para>
+ the repository through Alioth's <ulink url="http://svn.debian.org/wsvn/debian-med/trunk/?rev=0&sc=0">web</ulink>
+ <ulink url="http://svn.debian.org/viewsvn/debian-med">interfaces</ulink>.</para>
<sect2>
<title>Give me the source!</title>
<para>
@@ -105,12 +118,42 @@
</listitem>
</itemizedlist>
</para>
+ <para>
+ Another way to check the sources is through the use of the
+ <command>debcheckout</command> command, from the
+ <ulink url="http://packages.debian.org/devscripts">devscripts</ulink>
+ package.
+ </para>
</sect2>
<sect2>
<title>Repository structure</title>
<para>The SVN repository is structured as follows:
-.1 debian-med/. .2 trunk/. .3 community/. .4 debtags/. .4 infrastructure/. .4 website/. .3 packages/. .4 <package>/. .5 branches/. .5 tags/. .5 trunk/. .6 debian/.
-</para>
+ <literallayout>
+ <code>
+debian-med/
+ └ trunk/
+ ├ community/
+ │ ├ debtags/
+ │ ├ infrastructure/
+ │ └ website/
+ └ packages/
+ ├ <package A>/
+ │ ├ branches/
+ │ ├ tags/
+ │ └ trunk/
+ │ └ debian/
+ ├ <package B>/
+ │ ├ branches/
+ │ ├ tags/
+ │ └ trunk/
+ │ └ debian/
+ …
+ </code>
+ </literallayout>
+ </para>
+ <note><para>We are currently considering an alternative layout in which all
+ the <filename>trunk</filename>, <filename>tags</filename> and
+ <filename>branches</filename> directories are grouped together, so that developpers can checkout trunks without tags.</para></note>
</sect2>
</sect1>
<sect1>
@@ -118,15 +161,15 @@
<sect2>
<title>Announcing intent to package</title>
<para>If you intent to work on a Debian package you should follow
- the <link xlink:href="http://www.debian.org/devel/wnpp/#l1">normal Debian rules</link> and file a <acronym>WNPP</acronym> bug report.</para>
+ the <ulink url="http://www.debian.org/devel/wnpp/#l1">normal Debian rules</ulink> and file a <acronym>WNPP</acronym> bug report.</para>
<para>It is a good idea to keep the Debian-Med mailing list
- <link xlink:href="mailto:debian-med at lists.debian.org">debian-med at lists.debian.org</link>
+ <ulink url="mailto:debian-med at lists.debian.org">debian-med at lists.debian.org</ulink>
in CC or forward the response of the BTS that includes the bug
number to the mailing list to keep your co-workers informed.</para>
<para>In addition to this you should add a user tag to this
<acronym>WNPP</acronym> bug to make sure that your intent is in focus
of the Debian-Med team.</para>
- <para>This can be done by sending a mail to <link xlink:href="mailto:request at bugs.debian.org">request at bugs.debian.org</link>
+ <para>This can be done by sending a mail to <ulink url="mailto:request at bugs.debian.org">request at bugs.debian.org</ulink>
with the following content:</para>
<blockquote>
<programlisting>user debian-med at lists.debian.org
@@ -144,36 +187,106 @@
...</programlisting>
</blockquote>
</sect2>
+ </sect1>
+ <sect1>
+ <title>Policy</title>
<sect2>
- <title>Conventions</title>
- <para>Please, in <filename>debian/control</filename>, use these values:</para>
- <blockquote>
- <programlisting>...
-Section: ...
-Priority: ...
-Maintainer: Debian-Med Packaging Team <debian-med-packaging at lists.alioth.debian.org>
-XS-DM-Upload-Allowed: yes
-Uploaders: <yourname> <youremail>
-Standards-Version: 3.7.3
-Homepage: http://...
+ <title><filename>debian/control</filename></title>
+ <orderedlist>
+ <listitem>
+ <formalpara>
+ <title>Section</title>
+ <para>Should be <quote>science</quote> for the source package.</para>
+ </formalpara>
+ </listitem>
+
+ <listitem>
+ <formalpara>
+ <title>Priority</title>
+ <para>Should be <quote>optional</quote> unless forbidden by the Debian policy (see section 2.5). Packages of priority <quote>extra</quote> are excluded from some QA tests.</para>
+ </formalpara>
+ </listitem>
+
+ <listitem>
+ <formalpara>
+ <title>Maintainer</title>
+ <para>Maintainer should be Debian-Med Packaging Team <email>debian-med-packaging at lists.alioth.debian.org</email>. Please subscribe to this list if you list yourself in the <code>Uploaders:</code> field of one of Debian-Med's packages. You can refer to the <ulink url="http://qa.debian.org/developer.php?login=debian-med-packaging@lists.alioth.debian.org">QA page</ulink> corresponding to this email to gather information about the packages.</para>
+ </formalpara>
+ </listitem>
+
+ <listitem>
+ <formalpara>
+ <title>Upload by Debian Maintainers</title>
+ <para>Should be enabled with the field <code>DM-Upload-Allowed: yes</code>. This means that when an Uploader becomes Debian Maintainer, he will immediately get the possibility to upload the package to Debian. Please consider this when you sponsor packages in which some Uploaders are added.</para>
+ </formalpara>
+ </listitem>
+
+ <listitem>
+ <formalpara>
+ <title>Uploaders</title>
+ <para>Please add yourelf as an uploader when you have a significant interest in a package. Being Uploader means that you are expected to answer to the bug reports. It is totally acceptable to do some QA work on a package without adding oneself to the Uploaders field.
+ </para>
+ </formalpara>
+ </listitem>
+
+ <listitem>
+ <formalpara>
+ <title>Standards-Version</title>
+ <para>Please always use the latest unless there are concerns for backporting. If no changes are needed, please indicate this fact in the changelog, and increment the value of the field.</para>
+ </formalpara>
+ </listitem>
+
+ <listitem>
+ <formalpara>
+ <title>Homepage</title>
+ <para>should be documented whenever possible</para>
+ </formalpara>
+ </listitem>
+
+ <listitem>
+ <formalpara>
+ <title>Vcs-Svn: and Vcs-Browser:</title>
+ <para>Please use the following template:</para>
+ <programlisting>
Vcs-Svn: svn://svn.debian.org/svn/debian-med/trunk/packages/<package>/trunk/
Vcs-Browser: http://svn.debian.org/wsvn/debian-med/trunk/packages/<package>/trunk/?rev=0&sc=0
-...</programlisting>
- </blockquote>
- <para>Make sure you use the right Section and Priority fields for
- the package. Also, be sure to use the latest Standards-Version.
- Please also add the Homepage field, we aim at having our packages
- the most complete as they can be.</para>
+ </programlisting>
+ </formalpara>
+ </listitem>
+ </orderedlist>
</sect2>
+
<sect2>
+ <title><filename>debian/copyright</filename></title>
+ <para>We use the <ulink url="http://wiki.debian.org/Proposals/CopyrightFormat">proposed machine-readable format</ulink> for the <filename>debian/copyright</filename> file. Please list yourself in the <computeroutput>Files: debian/*</computeroutput> section if you think that your contributions are not trivial and therefore subjected to copyright. Please chose a license that is compatible with the program you package. You can also use <quote>same as if it were in the public domain</quote> or <quote>same as the packaged program itself</quote>.</para>
+ </sect2>
+
+ <sect2>
+ <title><filename>debian/changelog</filename></title>
+ <para>Packages hosted in our Subversion repository, that have been modified but not uploaded must use <emphasis>UNRELEASED</emphasis> as a distribution name. This can be done automatically by declaring <emphasis>DEBCHANGE_RELEASE_HEURISTIC=changelog</emphasis> in <filename>~/.devscripts</filename> and using <command>dch</command>.</para>
+ </sect2>
+
+ <sect2>
+ <title>Debhelper</title>
+ <para>Debhelper uses compatibility levels to control the behaviour of its commands. The latest level is not always available in <emphasis>Stable</emphasis> or <emphasis>Backports</emphasis>. Please avoid using it unless needed until it is available, to facilitate backporting. We currently recommend to use the level <emphasis>5</emphasis>.</para>
+ </sect2>
+
+ <sect2>
+ <title>CDBS</title>
+ <para>The use of CDBS is welcome as it helps us to factorise our code. Nevertheless, please do not use complex CDBS for non-trivial packages, so that other developpers can quickly understand the package when doing QA work.</para>
+ <para>It is technically possible to build CDBS packages using Debhelper without the <filename>debian/compat</filename> file. Please do not, and always include such a file according to the above guidelines.</para>
+ </sect2>
+
+ <sect2>
<title>Injecting a new package</title>
<para>To inject a new package to the SVN repository, you must have
- write access to it; i.e. you must be a member of this group.</para>
+ write access to it; i.e. you must be a member of the <emphasis>debian-med</emphasis> group on Alioth.</para>
<para>You can inject a new package only after successfully building
- it with <command>dpkg-buildpackage</command> (or any wrapper around it). Then you can:</para>
+ it with <command>dpkg-buildpackage</command> (or any wrapper around it). We use the MergeWithUpstream workflow, so please keep all the modifications in the <filename>debian</filename> directory, and use the <option>-o</option> of <command>svn-buildpackage</command>, as in the following example:</para>
<blockquote>
<para><userinput>
<command>svn-inject</command>
+ <option>-o</option>
<filename>package.dsc</filename>
<filename class="directory">svn+ssh://user@alioth.debian.org/svn/debian-med/trunk/packages/</filename>
</userinput></para>
@@ -183,7 +296,7 @@
<command>apt-get</command> it).</para>
<para>Once you injected a new package please make sure that it is
mentioned in the apropriate tasks file in the package source of the
- debian-med package in SVN. Normally maintainer watch the changes in
+ debian-med <acronym>CDD</acronym> package in SVN. Normally maintainer watch the changes in
the Debian-Med packaging pool but it helps if the maintainer of a
certain package verifies that everything is in the right place.</para>
</sect2>
@@ -224,7 +337,7 @@
<para>(also <command>svn ci</command>).</para>
<para>Otherwise, you can ask to be added to the group (see the Membership
section), or send the result of svn diff to the
- <link xlink:href="mailto:debian-med at lists.debian.org">mailing list</link>
+ <ulink url="mailto:debian-med at lists.debian.org">mailing list</ulink>
(<command>gzip -9</command> it, if it's too large).</para>
</sect2>
<sect2>
@@ -276,10 +389,9 @@
Debian distribution: be this wrong paths, missing features, anything
that implies editing the source files. When you directly edit
upstream's source files, your changes will be put into a .diff.gz file,
- which should instead contain only debian. Because of this, it's best
- using a patch handling system which keeps patches under the
- <filename class="directory">debian/</filename> directory.</para>
- <para>The most known are <command>quilt</command> and <command>dpatch</command>.
+ which should instead contain only debian. To better organise the patches and group the by function, please use a patch handling system which keeps patches under the
+ <filename class="directory">debian/patches</filename> directory.</para>
+ <para>The most known are <command>quilt</command>, <emphasis>simple-patchsys</emphasis> (from the <emphasis>CDBS</emphasis> package) and <command>dpatch</command>.
Please don't use any other patch system in Debian-Med, unless absolutely
necessary.</para>
<sect3>
@@ -381,7 +493,7 @@
<blockquote>
<programlisting>include <filename class="headerfile">/usr/share/quilt/quilt.make</filename></programlisting>
</blockquote>
- <para>Remember to add the needed dependencies to its
+ <para>Please use this to import patch and unpatch rules instead of writing them, and remember to add the needed dependencies to its
targets:</para>
<blockquote>
<programlisting>...
More information about the debian-med-commit
mailing list