/[ddp]/manuals/trunk/developers-reference/pkgs.dbk
ViewVC logotype

Diff of /manuals/trunk/developers-reference/pkgs.dbk

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 4910 by debacle, Sat Jun 30 13:21:18 2007 UTC revision 4911 by debacle, Sun Jul 1 11:50:47 2007 UTC
# Line 1  Line 1 
1  <?xml version="1.0" encoding="utf-8"?>  <?xml version="1.0" encoding="utf-8"?>
2  <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"  <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3      "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [      "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4    <!ENTITY % commondata  SYSTEM "common.ent" > %commondata;    <!ENTITY % commondata SYSTEM "common.ent" > %commondata;
5  ]>  ]>
6  <chapter id="pkgs">  <chapter id="pkgs">
7  <title>Managing Packages</title>  <title>Managing Packages</title>
# Line 32  You should set the subject of the bug to Line 32  You should set the subject of the bug to
32  -- <replaceable>short description</replaceable>'', substituting the name of the  -- <replaceable>short description</replaceable>'', substituting the name of the
33  new package for <replaceable>foo</replaceable>.  The severity of the bug report  new package for <replaceable>foo</replaceable>.  The severity of the bug report
34  must be set to <emphasis>wishlist</emphasis>.  If you feel it's necessary, send  must be set to <emphasis>wishlist</emphasis>.  If you feel it's necessary, send
35  a copy to <email>debian-devel@&lists-host;</email> by putting the address  a copy to &email-debian-devel; by putting the address in the
36  in the <literal>X-Debbugs-CC:</literal> header of the message (no, don't use  <literal>X-Debbugs-CC:</literal> header of the message (no, don't use
37  <literal>CC:</literal>, because that way the message's subject won't indicate  <literal>CC:</literal>, because that way the message's subject won't indicate
38  the bug number).  the bug number).
39  </para>  </para>
# Line 338  packages uninstallable, is strongly disc Line 338  packages uninstallable, is strongly disc
338  </para>  </para>
339  <para>  <para>
340  The Release Team (which can be reached at  The Release Team (which can be reached at
341  <email>debian-release@&lists-host;</email>) will regularly evaluate the  &email-debian-release;) will regularly evaluate the uploads To
342  uploads To <emphasis>stable-proposed-updates</emphasis> and decide if your  <emphasis>stable-proposed-updates</emphasis> and decide if your package can be
343  package can be included in <emphasis>stable</emphasis>.  Please be clear (and  included in <emphasis>stable</emphasis>.  Please be clear (and verbose, if
344  verbose, if necessary) in your changelog entries for uploads to  necessary) in your changelog entries for uploads to
345  <emphasis>stable</emphasis>, because otherwise the package won't be considered  <emphasis>stable</emphasis>, because otherwise the package won't be considered
346  for inclusion.  for inclusion.
347  </para>  </para>
# Line 512  file</emphasis>. Line 512  file</emphasis>.
512  <para>  <para>
513  To alter the actual section that a package is put in, you need to first make  To alter the actual section that a package is put in, you need to first make
514  sure that the <filename>debian/control</filename> file in your package is  sure that the <filename>debian/control</filename> file in your package is
515  accurate.  Next, send an email <email>override-change@debian.org</email> or  accurate.  Next, send an email &email-override; or submit a
516  submit a bug against <systemitem role="package">&ftp-debian-org;</systemitem>  bug against <systemitem role="package">ftp.debian.org</systemitem> requesting
517  requesting that the section or priority for your package be changed from the  that the section or priority for your package be changed from the old section
518  old section or priority to the new one.  Be sure to explain your reasoning.  or priority to the new one.  Be sure to explain your reasoning.
519  </para>  </para>
520  <para>  <para>
521  For more information about <emphasis>override files</emphasis>, see  For more information about <emphasis>override files</emphasis>, see
# Line 565  can check them by browsing this page: Line 565  can check them by browsing this page:
565  </para>  </para>
566  <para>  <para>
567  Maintainers interact with the BTS via email addresses at  Maintainers interact with the BTS via email addresses at
568  <literal>&bugs-host;</literal>.  Documentation on available commands can be  <literal>&bugs-host;</literal>.  Documentation on available
569  found at <ulink url="&url-bts;"></ulink>, or, if you have  commands can be found at <ulink url="&url-bts;"></ulink>, or,
570  installed the <systemitem role="package">doc-debian</systemitem> package, you  if you have installed the <systemitem role="package">doc-debian</systemitem>
571  can look at the local files <filename>/usr/share/doc/debian/bug-*</filename>.  package, you can look at the local files &file-bts-docs;.
572  </para>  </para>
573  <para>  <para>
574  Some find it useful to get periodic reports on open bugs.  You can add a cron  Some find it useful to get periodic reports on open bugs.  You can add a cron
# Line 609  linkend="upload-bugfix"/> . Line 609  linkend="upload-bugfix"/> .
609  </para>  </para>
610  <para>  <para>
611  You should <emphasis>never</emphasis> close bugs via the bug server  You should <emphasis>never</emphasis> close bugs via the bug server
612  <literal>close</literal> command sent to  <literal>close</literal> command sent to &email-bts-control;.
613  <email>control@&bugs-host;</email>.  If you do so, the original submitter  If you do so, the original submitter will not receive any information about why
614  will not receive any information about why the bug was closed.  the bug was closed.
615  </para>  </para>
616  </section>  </section>
617    
# Line 657  unacceptable, you (or the submitter) may Line 657  unacceptable, you (or the submitter) may
657  technical committee by reassigning the bug to <systemitem  technical committee by reassigning the bug to <systemitem
658  role="package">tech-ctte</systemitem> (you may use the clone command of the BTS  role="package">tech-ctte</systemitem> (you may use the clone command of the BTS
659  if you wish to keep it reported against your package).  Before doing so, please  if you wish to keep it reported against your package).  Before doing so, please
660  read the <ulink url="&url-devel-docs;tech-ctte">recommended  read the <ulink url="&url-tech-ctte;">recommended
661  procedure</ulink>.  procedure</ulink>.
662  </para>  </para>
663  </listitem>  </listitem>
# Line 666  procedure</ulink>. Line 666  procedure</ulink>.
666  If the bug is real but it's caused by another package, just reassign the bug to  If the bug is real but it's caused by another package, just reassign the bug to
667  the right package.  If you don't know which package it should be reassigned to,  the right package.  If you don't know which package it should be reassigned to,
668  you should ask for help on <link linkend="irc-channels">IRC</link> or  you should ask for help on <link linkend="irc-channels">IRC</link> or
669  on <email>debian-devel@&lists-host;</email>.  Please make sure that the  on &email-debian-devel;.  Please make sure that the
670  maintainer(s) of the package the bug is reassigned to know why you reassigned  maintainer(s) of the package the bug is reassigned to know why you reassigned
671  it.  it.
672  </para>  </para>
# Line 703  someone, the bug may be closed. Line 703  someone, the bug may be closed.
703  <para>  <para>
704  If the bug is related to the packaging, you just fix it.  If you are not able  If the bug is related to the packaging, you just fix it.  If you are not able
705  to fix it yourself, then tag the bug as <literal>help</literal>.  You can also  to fix it yourself, then tag the bug as <literal>help</literal>.  You can also
706  ask for help on <email>debian-devel@&lists-host;</email> or  ask for help on &email-debian-devel; or
707  <email>debian-qa@&lists-host;</email>.  If it's an upstream problem, you  &email-debian-qa;.  If it's an upstream problem, you have to
708  have to forward it to the upstream author.  Forwarding a bug is not enough, you  forward it to the upstream author.  Forwarding a bug is not enough, you have to
709  have to check at each release if the bug has been fixed or not.  If it has, you  check at each release if the bug has been fixed or not.  If it has, you just
710  just close it, otherwise you have to remind the author about it.  If you have  close it, otherwise you have to remind the author about it.  If you have the
711  the required skills you can prepare a patch that fixes the bug and send it to  required skills you can prepare a patch that fixes the bug and send it to the
712  the author at the same time.  Make sure to send the patch to the BTS and to tag  author at the same time.  Make sure to send the patch to the BTS and to tag the
713  the bug as <literal>patch</literal>.  bug as <literal>patch</literal>.
714  </para>  </para>
715  </listitem>  </listitem>
716  <listitem>  <listitem>
# Line 784  If you happen to mistype a bug number or Line 784  If you happen to mistype a bug number or
784  don't hesitate to undo any damage the error caused.  To reopen wrongly closed  don't hesitate to undo any damage the error caused.  To reopen wrongly closed
785  bugs, send a <literal>reopen <replaceable>XXX</replaceable></literal> command  bugs, send a <literal>reopen <replaceable>XXX</replaceable></literal> command
786  to the bug tracking system's control address,  to the bug tracking system's control address,
787  <email>control@&bugs-host;</email>.  To close any remaining bugs that were  &email-bts-control;.  To close any remaining bugs that were
788  fixed by your upload, email the <filename>.changes</filename> file to  fixed by your upload, email the <filename>.changes</filename> file to
789  <email>XXX-done@&bugs-host;</email>, where <replaceable>XXX</replaceable>  <email>XXX-done@&bugs-host;</email>, where <replaceable>XXX</replaceable>
790  is the bug number, and put Version: YYY and an empty line as the first two  is the bug number, and put Version: YYY and an empty line as the first two
# Line 820  security.debian.org. Line 820  security.debian.org.
820  When you become aware of a security-related bug in a Debian package, whether or  When you become aware of a security-related bug in a Debian package, whether or
821  not you are the maintainer, collect pertinent information about the problem,  not you are the maintainer, collect pertinent information about the problem,
822  and promptly contact the security team at  and promptly contact the security team at
823  <email>team@security.debian.org</email> as soon as possible.  <emphasis  &email-security-team; as soon as possible.  <emphasis
824  role="strong">DO NOT UPLOAD</emphasis> any packages for stable; the security  role="strong">DO NOT UPLOAD</emphasis> any packages for stable; the security
825  team will do that.  Useful information includes, for example:  team will do that.  Useful information includes, for example:
826  </para>  </para>
# Line 933  has become public. Line 933  has become public.
933  Security advisories are only issued for the current, released stable  Security advisories are only issued for the current, released stable
934  distribution, and <emphasis>not</emphasis> for testing or unstable.  When  distribution, and <emphasis>not</emphasis> for testing or unstable.  When
935  released, advisories are sent to the  released, advisories are sent to the
936  <email>debian-security-announce@&lists-host;</email> mailing list and  &email-debian-security-announce; mailing list and posted on
937  posted on <ulink url="http://&www-debian-org;/security/">the security web  <ulink url="&url-debian-security-advisories;">the security web
938  page</ulink>.  Security advisories are written and posted by the security team.  page</ulink>.  Security advisories are written and posted by the security team.
939  However they certainly do not mind if a maintainer can supply some of the  However they certainly do not mind if a maintainer can supply some of the
940  information for them, or write part of the text.  Information that should be in  information for them, or write part of the text.  Information that should be in
# Line 1222  described in <xref linkend="override-fil Line 1222  described in <xref linkend="override-fil
1222  <para>  <para>
1223  If for some reason you want to completely remove a package (say, if it is an  If for some reason you want to completely remove a package (say, if it is an
1224  old compatibility library which is no longer required), you need to file a bug  old compatibility library which is no longer required), you need to file a bug
1225  against <literal>&ftp-debian-org;</literal> asking that the package be removed;  against <literal>ftp.debian.org</literal> asking that the package be removed;
1226  as all bugs, this bug should normally have normal severity.  Make sure you  as all bugs, this bug should normally have normal severity.  Make sure you
1227  indicate which distribution the package should be removed from.  Normally, you  indicate which distribution the package should be removed from.  Normally, you
1228  can only have packages removed from <emphasis>unstable</emphasis> and  can only have packages removed from <emphasis>unstable</emphasis> and
# Line 1259  and <ulink url="&url-debian-qa;howto-rem Line 1259  and <ulink url="&url-debian-qa;howto-rem
1259  </para>  </para>
1260  <para>  <para>
1261  If in doubt concerning whether a package is disposable, email  If in doubt concerning whether a package is disposable, email
1262  <email>debian-devel@&lists-host;</email> asking for opinions.  Also of  &email-debian-devel; asking for opinions.  Also of interest is
1263  interest is the <command>apt-cache</command> program from the <systemitem  the <command>apt-cache</command> program from the <systemitem
1264  role="package">apt</systemitem> package.  When invoked as <literal>apt-cache  role="package">apt</systemitem> package.  When invoked as <literal>apt-cache
1265  showpkg <replaceable>package</replaceable></literal>, the program will show  showpkg <replaceable>package</replaceable></literal>, the program will show
1266  details for <replaceable>package</replaceable>, including reverse depends.  details for <replaceable>package</replaceable>, including reverse depends.
1267  Other useful programs include <literal>apt-cache rdepends</literal>,  Other useful programs include <literal>apt-cache rdepends</literal>,
1268  <command>apt-rdepends</command> and <command>grep-dctrl</command>.  Removal of  <command>apt-rdepends</command> and <command>grep-dctrl</command>.  Removal of
1269  orphaned packages is discussed on <email>debian-qa@&lists-host;</email>.  orphaned packages is discussed on &email-debian-qa;.
1270  </para>  </para>
1271  <para>  <para>
1272  Once the package has been removed, the package's bugs should be handled.  They  Once the package has been removed, the package's bugs should be handled.  They
# Line 1300  process to rename it.  First, set your < Line 1300  process to rename it.  First, set your <
1300  to replace and conflict with the obsolete name of the package (see the <ulink  to replace and conflict with the obsolete name of the package (see the <ulink
1301  url="&url-debian-policy;">Debian Policy Manual</ulink> for  url="&url-debian-policy;">Debian Policy Manual</ulink> for
1302  details).  Once you've uploaded the package and the package has moved into the  details).  Once you've uploaded the package and the package has moved into the
1303  archive, file a bug against <literal>&ftp-debian-org;</literal> asking to remove  archive, file a bug against <literal>ftp.debian.org</literal> asking to remove
1304  the package with the obsolete name.  Do not forget to properly reassign the  the package with the obsolete name.  Do not forget to properly reassign the
1305  package's bugs at the same time.  package's bugs at the same time.
1306  </para>  </para>
# Line 1323  mirror network. Line 1323  mirror network.
1323  <para>  <para>
1324  If you can no longer maintain a package, you need to inform others, and see  If you can no longer maintain a package, you need to inform others, and see
1325  that the package is marked as orphaned.  You should set the package maintainer  that the package is marked as orphaned.  You should set the package maintainer
1326  to <literal>Debian QA Group &lt;&pts-host;&gt;</literal> and submit  to <literal>Debian QA Group &orphan-address;</literal> and
1327  a bug report against the pseudo package <systemitem  submit a bug report against the pseudo package <systemitem
1328  role="package">wnpp</systemitem>.  The bug report should be titled <literal>O:  role="package">wnpp</systemitem>.  The bug report should be titled <literal>O:
1329  <replaceable>package</replaceable> -- <replaceable>short  <replaceable>package</replaceable> -- <replaceable>short
1330  description</replaceable></literal> indicating that the package is now  description</replaceable></literal> indicating that the package is now
1331  orphaned.  The severity of the bug should be set to  orphaned.  The severity of the bug should be set to
1332  <emphasis>normal</emphasis>; if the package has a priority of standard or  <emphasis>normal</emphasis>; if the package has a priority of standard or
1333  higher, it should be set to important.  If you feel it's necessary, send a copy  higher, it should be set to important.  If you feel it's necessary, send a copy
1334  to <email>debian-devel@&lists-host;</email> by putting the address in the  to &email-debian-devel; by putting the address in the
1335  X-Debbugs-CC: header of the message (no, don't use CC:, because that way the  X-Debbugs-CC: header of the message (no, don't use CC:, because that way the
1336  message's subject won't indicate the bug number).  message's subject won't indicate the bug number).
1337  </para>  </para>
# Line 1371  package.  Complaints about maintainers s Line 1371  package.  Complaints about maintainers s
1371  mailing list.  If the discussion doesn't end with a positive conclusion, and  mailing list.  If the discussion doesn't end with a positive conclusion, and
1372  the issue is of a technical nature, consider bringing it to the attention of  the issue is of a technical nature, consider bringing it to the attention of
1373  the technical committee (see the <ulink  the technical committee (see the <ulink
1374  url="&url-devel-docs;tech-ctte">technical committee web  url="&url-tech-ctte;">technical committee web page</ulink> for
1375  page</ulink> for more information).  more information).
1376  </para>  </para>
1377  <para>  <para>
1378  If you take over an old package, you probably want to be listed as the  If you take over an old package, you probably want to be listed as the
# Line 1758  architectures: A porter or any other per Line 1758  architectures: A porter or any other per
1758  accidently upload it without noticing it doesn't work.  If in the past some  accidently upload it without noticing it doesn't work.  If in the past some
1759  binary packages were uploaded on unsupported architectures, request their  binary packages were uploaded on unsupported architectures, request their
1760  removal by filing a bug against <systemitem  removal by filing a bug against <systemitem
1761  role="package">&ftp-debian-org;</systemitem>  role="package">ftp.debian.org</systemitem>
1762  </para>  </para>
1763  </section>  </section>
1764    
# Line 2032  Unless you know the maintainer is still Line 2032  Unless you know the maintainer is still
2032  to see if it has been orphaned.  The current list of orphaned packages which  to see if it has been orphaned.  The current list of orphaned packages which
2033  haven't had their maintainer set correctly is available at <ulink  haven't had their maintainer set correctly is available at <ulink
2034  url="&url-debian-qa-orphaned;"></ulink>.  If you perform an NMU on an  url="&url-debian-qa-orphaned;"></ulink>.  If you perform an NMU on an
2035  improperly orphaned package, please set the maintainer to ``Debian QA Group  improperly orphaned package, please set the maintainer to <literal>Debian QA Group
2036  &lt;&pts-host;&gt;''.  &lt;packages@qa.debian.org&gt;</literal>.
2037  </para>  </para>
2038  </section>  </section>
2039    
# Line 2238  all the necessary criteria); Line 2238  all the necessary criteria);
2238  <para>  <para>
2239  To find out whether a package is progressing into testing or not, see the  To find out whether a package is progressing into testing or not, see the
2240  testing script output on the <ulink  testing script output on the <ulink
2241  url="&url-devel-docs;testing">web page of the testing  url="&url-testing-maint;">web page of the testing
2242  distribution</ulink>, or use the program <command>grep-excuses</command> which  distribution</ulink>, or use the program <command>grep-excuses</command> which
2243  is in the <systemitem role="package">devscripts</systemitem> package.  This  is in the <systemitem role="package">devscripts</systemitem> package.  This
2244  utility can easily be used in a <citerefentry>  utility can easily be used in a <citerefentry>
# Line 2250  to keep yourself informed of the progres Line 2250  to keep yourself informed of the progres
2250  The <filename>update_excuses</filename> file does not always give the precise  The <filename>update_excuses</filename> file does not always give the precise
2251  reason why the package is refused; you may have to find it on your own by  reason why the package is refused; you may have to find it on your own by
2252  looking for what would break with the inclusion of the package.  The <ulink  looking for what would break with the inclusion of the package.  The <ulink
2253  url="&url-devel-docs;testing">testing web page</ulink> gives some  url="&url-testing-maint;">testing web page</ulink> gives some
2254  more information about the usual problems which may be causing such troubles.  more information about the usual problems which may be causing such troubles.
2255  </para>  </para>
2256  <para>  <para>
# Line 2403  considered for update. Line 2403  considered for update.
2403  </para>  </para>
2404  <para>  <para>
2405  Currently, this requires some manual hinting from the release team.  Please  Currently, this requires some manual hinting from the release team.  Please
2406  contact them by sending mail to <email>debian-release@&lists-host;</email>  contact them by sending mail to &email-debian-release; if this
2407  if this happens to one of your packages.  happens to one of your packages.
2408  </para>  </para>
2409  </section>  </section>
2410    
# Line 2477  Keep in mind that packages uploaded ther Line 2477  Keep in mind that packages uploaded ther
2477  have to go through the hands of the release manager.  So you'd better have a  have to go through the hands of the release manager.  So you'd better have a
2478  good reason to upload there.  In order to know what a good reason is in the  good reason to upload there.  In order to know what a good reason is in the
2479  release managers' eyes, you should read the instructions that they regularly  release managers' eyes, you should read the instructions that they regularly
2480  give on <email>debian-devel-announce@&lists-host;</email>.  give on &email-debian-devel-announce;.
2481  </para>  </para>
2482  <para>  <para>
2483  You should not upload to <emphasis>testing-proposed-updates</emphasis> when you  You should not upload to <emphasis>testing-proposed-updates</emphasis> when you
# Line 2535  and lower than in <emphasis>unstable</em Line 2535  and lower than in <emphasis>unstable</em
2535  <listitem>  <listitem>
2536  <para>  <para>
2537  After uploading and successful build on all platforms, contact the release team  After uploading and successful build on all platforms, contact the release team
2538  at <email>debian-release@&lists-host;</email> and ask them to approve your  at &email-debian-release; and ask them to approve your upload.
 upload.  
2539  </para>  </para>
2540  </listitem>  </listitem>
2541  </itemizedlist>  </itemizedlist>
Legend:
Removed from v.4910  
changed lines
  Added in v.4911
  ViewVC Help
Powered by ViewVC 1.1.5