From: debacle Date: Sun, 1 Jul 2007 11:50:47 +0000 (+0000) Subject: Fixed remaining entities. X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=developers-reference.git;a=commitdiff_plain;h=a52b7e8c084a73282543e5e870ae8c68ed2abcb1 Fixed remaining entities. git-svn-id: svn://anonscm.debian.org/ddp/developers-reference/trunk@4911 313b444b-1b9f-4f58-a734-7bb04f332e8d --- diff --git a/best-pkging-practices.dbk b/best-pkging-practices.dbk index 981c35f..ca1bfb3 100644 --- a/best-pkging-practices.dbk +++ b/best-pkging-practices.dbk @@ -1,7 +1,7 @@ %commondata; + %commondata; ]> Best Packaging Practices @@ -80,7 +80,7 @@ Some people feel that vanilla debian/rules files are better, since you don't have to learn the intricacies of any helper system. This decision is completely up to you. Use what works for you. Many examples of vanilla debian/rules files are available at . +url="&url-rules-files;">. @@ -203,8 +203,7 @@ Postscript or postscript. If you are having problems writing your description, you may wish to send it -along to debian-l10n-english@&lists-host; and request -feedback. +along to &email-debian-l10n-english; and request feedback. @@ -343,7 +342,7 @@ added at the end of description, using the following format: Note the spaces prepending the line, which serves to break the lines correctly. To see an example of how this displays, see . +url="&url-eg-desc-upstream-info;">. If there is no home page for the software, this should naturally be left out. @@ -740,8 +739,8 @@ Most Debian package maintainers are not native English speakers. So, writing properly phrased templates may not be easy for them. -Please use (and abuse) debian-l10n-english@&lists-host; -mailing list. Have your templates proofread. +Please use (and abuse) &email-debian-l10n-english; mailing +list. Have your templates proofread. Badly written templates give a poor image of your package, of your work...or @@ -784,14 +783,14 @@ translations and request them for updates. If in doubt, you may also contact the translation team for a given language (debian-l10n-xxxxx@&lists-host;), or the -debian-i18n@&lists-host; mailing list. +&email-debian-i18n; mailing list. -Calls for translations posted to debian-i18n@&lists-host; -with the debian/po/templates.pot file attached or -referenced in a URL are encouraged. Be sure to mentions in these calls for new -translations which languages you have existing translations for, in order to -avoid duplicate work. +Calls for translations posted to &email-debian-i18n; with the +debian/po/templates.pot file attached or referenced in a +URL are encouraged. Be sure to mentions in these calls for new translations +which languages you have existing translations for, in order to avoid duplicate +work. @@ -1283,13 +1282,12 @@ differences between two versions of the documentation, so, for instance, they can see what needs to be retranslated. It is recommended that the translated documentation maintain a note about what source control revision the translation is based on. An interesting system is provided by doc-check in the boot-floppies package, which shows an overview of -the translation status for any given language, using structured comments for -the current revision of the file to be translated and, for a translated file, -the revision of the original file the translation is based on. You might wish -to adapt and provide that in your CVS area. +url="&url-i18n-doc-check;">doc-check in the +boot-floppies package, which shows an +overview of the translation status for any given language, using structured +comments for the current revision of the file to be translated and, for a +translated file, the revision of the original file the translation is based on. +You might wish to adapt and provide that in your CVS area. If you maintain XML or SGML documentation, we suggest that you isolate any @@ -1387,8 +1385,8 @@ role="package">libmldbm-perl (arch independent perl module). Python related packages have their python policy; see -/usr/share/doc/python/python-policy.txt.gz in the -python package. +&file-python-policy; in the python package. @@ -1408,9 +1406,9 @@ policy. Ocaml related packages have their own policy, found in -/usr/share/doc/ocaml/ocaml_packaging_policy.gz from the -ocaml package. A good example is the -camlzip source package. +&file-ocaml-policy; from the ocaml package. A good example is the camlzip source package. @@ -1478,7 +1476,7 @@ If you need a certain locale during build, you can create a temporary file via this trick: -If you set LOCPATH to the equivalent of /usr/lib/locale, and LC_ALL to the name +If you set LOCPATH to the equivalent of /usr/lib/locale, and LC_ALL to the name of the locale you generate, you should get what you want without being root. Something like this: diff --git a/beyond-pkging.dbk b/beyond-pkging.dbk index 9b8de92..0d27668 100644 --- a/beyond-pkging.dbk +++ b/beyond-pkging.dbk @@ -1,7 +1,7 @@ %commondata; + %commondata; ]> Beyond Packaging @@ -77,17 +77,17 @@ role="package">lintian so that an error or warning is emitted. If you report more than 10 bugs on the same topic at once, it is recommended -that you send a message to debian-devel@&lists-host; -describing your intention before submitting the report, and mentioning the fact -in the subject of your mail. This will allow other developers to verify that -the bug is a real problem. In addition, it will help prevent a situation in -which several maintainers start filing the same bug report simultaneously. +that you send a message to &email-debian-devel; describing +your intention before submitting the report, and mentioning the fact in the +subject of your mail. This will allow other developers to verify that the bug +is a real problem. In addition, it will help prevent a situation in which +several maintainers start filing the same bug report simultaneously. Please use the programms dd-list and if appropriate whodepends (from the package devscripts) to generate a list of all affected packages, and include the output in your mail to -debian-devel@&lists-host;. +&email-debian-devel;. Note that when sending lots of bugs on the same subject, you should send the @@ -110,9 +110,9 @@ linkend="lintian"/> ) as possible. If you do not find that possible, then you should consider orphaning some of your packages (see ). Alternatively, you may ask the help of other people in order to catch up with the backlog of bugs that you have (you can ask for -help on debian-qa@&lists-host; or -debian-devel@&lists-host;). At the same time, you can look -for co-maintainers (see ). +help on &email-debian-qa; or +&email-debian-devel;). At the same time, you can look for +co-maintainers (see ). @@ -121,10 +121,10 @@ for co-maintainers (see ). From time to time the QA group organizes bug squashing parties to get rid of as many problems as possible. They are announced on -debian-devel-announce@&lists-host; and the announcement -explains which area will be the focus of the party: usually they focus on -release critical bugs but it may happen that they decide to help finish a major -upgrade (like a new perl version which requires recompilation of all the binary +&email-debian-devel-announce; and the announcement explains +which area will be the focus of the party: usually they focus on release +critical bugs but it may happen that they decide to help finish a major upgrade +(like a new perl version which requires recompilation of all the binary modules). @@ -244,13 +244,13 @@ package, they're responsible for the upload anyhow, and are likely to know what happened to the person they sponsored. -It is also allowed to post a query to -debian-devel@&lists-host;, asking if anyone is aware of the -whereabouts of the missing maintainer. Please Cc: the person in question. +It is also allowed to post a query to &email-debian-devel;, +asking if anyone is aware of the whereabouts of the missing maintainer. Please +Cc: the person in question. Once you have gathered all of this, you can contact -mia@qa.debian.org. People on this alias will use the +&email-mia;. People on this alias will use the information you provide in order to decide how to proceed. For example, they might orphan one or all of the packages of the maintainer. If a package has been NMUed, they might prefer to contact the NMUer before orphaning the package @@ -274,7 +274,7 @@ someone with more time. If you are interested in working in the MIA team, please have a look at the README file in /org/qa.debian.org/mia on qa.debian.org where the technical details and the MIA procedures are documented and contact -mia@qa.debian.org. +&email-mia;. @@ -372,7 +372,7 @@ linkend="pkg-tracking-system"/> . Advocating new developers See the page about advocating a prospective +url="&url-newmaint-advocate;">advocating a prospective developer at the Debian web site. @@ -380,9 +380,8 @@ developer at the Debian web site.
Handling new maintainer applications -Please see Checklist for Application -Managers at the Debian web site. +Please see Checklist +for Application Managers at the Debian web site.
diff --git a/common.ent b/common.ent index 5a09ece..e90fad8 100644 --- a/common.ent +++ b/common.ent @@ -53,7 +53,6 @@ - @@ -81,27 +80,14 @@ - - - - -/org/ftp.debian.org/incoming/"> -/org/non-us.debian.org/incoming/"> - - - - - - - @@ -118,14 +104,11 @@ - - listmaster@&lists-host;"> -debian-announce@&lists-host;"> developers-reference@&packages-host;"> debian-changes@lists.debian.org"> debian-devel@&lists-host;"> @@ -137,7 +120,6 @@ debian-private@&lists-host;"> debian-project@&lists-host;"> debian-policy@&lists-host;"> -debian-user@&lists-host;"> debian-qa@&lists-host;"> debian-release@&lists-host;"> @@ -147,17 +129,13 @@ debian-l10n-english@&lists-host;"> mia@qa.debian.org"> -new-maintainer@debian.org"> -keyring-maint@debian.org"> debian-admin@debian.org"> ftpmaster@debian.org"> override-change@debian.org"> -wnpp@debian.org"> control@&bugs-host;"> team@security.debian.org"> -/usr/share/doc/debian/mailing-lists.txt"> /usr/share/doc/debian/bug-*"> /usr/share/doc/python/python-policy.txt.gz"> /usr/share/doc/ocaml/ocaml_packaging_policy.gz"> diff --git a/developer-duties.dbk b/developer-duties.dbk index 5a444e7..2e501f3 100644 --- a/developer-duties.dbk +++ b/developer-duties.dbk @@ -1,7 +1,7 @@ %commondata; + %commondata; ]> Debian Developer's Duties @@ -28,7 +28,7 @@ Be very careful with your private keys. Do not place them on any public servers or multiuser machines, such as the Debian servers (see ). Back your keys up; keep a copy offline. Read the documentation that comes with your software; read the PGP FAQ. +url="&url-pgp-faq;">PGP FAQ. You need to ensure not only that your key is secure against being stolen, but @@ -71,16 +71,16 @@ Constitution. Other than the yearly leader election, votes are not routinely held, and they are not undertaken lightly. Each proposal is first discussed on the -debian-vote@&lists-host; mailing list and it requires -several endorsements before the project secretary starts the voting procedure. +&email-debian-vote; mailing list and it requires several +endorsements before the project secretary starts the voting procedure. You don't have to track the pre-vote discussions, as the secretary will issue -several calls for votes on -debian-devel-announce@&lists-host; (and all developers are -expected to be subscribed to that list). Democracy doesn't work well if people -don't take part in the vote, which is why we encourage all developers to vote. -Voting is conducted via GPG-signed/encrypted email messages. +several calls for votes on &email-debian-devel-announce; (and +all developers are expected to be subscribed to that list). Democracy doesn't +work well if people don't take part in the vote, which is why we encourage all +developers to vote. Voting is conducted via GPG-signed/encrypted email +messages. The list of all proposals (past and current) is available on the %commondata; + %commondata; ]> @@ -9,7 +9,7 @@ Developer's Reference Team -developers-reference@&packages-host; +&email-devel-ref; Andreas Barth @@ -70,8 +70,8 @@ more details. A copy of the GNU General Public License is available as &file-GPL; in the &debian-formal; distribution or on the World Wide Web at the GNU web site. You can -also obtain it by writing to the &fsf-addr;. +url="&url-gpl;">the GNU web site. You can also obtain +it by writing to the &fsf-addr;. If you want to print this reference, you should use the %commondata; + %commondata; ]> Internationalizing, translating, being internationalized and being translated diff --git a/new-maintainer.dbk b/new-maintainer.dbk index 615d85e..3f71082 100644 --- a/new-maintainer.dbk +++ b/new-maintainer.dbk @@ -1,7 +1,7 @@ %commondata; + %commondata; ]> Applying to Become a Maintainer @@ -9,21 +9,20 @@ Getting started So, you've read all the documentation, you've gone through the Debian New Maintainers' +url="&url-newmaint-guide;">Debian New Maintainers' Guide, understand what everything in the hello example package is for, and you're about to Debianize your favorite piece of software. How do you actually become a Debian developer so that your work can be incorporated into the Project? -Firstly, subscribe to debian-devel@&lists-host; if you -haven't already. Send the word subscribe in the +Firstly, subscribe to &email-debian-devel; if you haven't +already. Send the word subscribe in the Subject of an email to -debian-devel-REQUEST@&lists-host;. In case of problems, -contact the list administrator at listmaster@&lists-host;. -More information on available mailing lists can be found in . -debian-devel-announce@&lists-host; is another list which is +&email-debian-devel-req;. In case of problems, contact the +list administrator at &email-listmaster;. More information on +available mailing lists can be found in . +&email-debian-devel-announce; is another list which is mandatory for anyone who wishes to follow Debian's development. @@ -32,28 +31,27 @@ doing any coding, and you should post about your intentions to work on something to avoid duplicated effort. -Another good list to subscribe to is -debian-mentors@&lists-host;. See -for details. The IRC channel #debian can also be helpful; -see . +Another good list to subscribe to is &email-debian-mentors;. +See for details. The IRC channel +#debian can also be helpful; see . -When you know how you want to contribute to &debian-formal;, you should get in -contact with existing Debian maintainers who are working on similar tasks. -That way, you can learn from experienced developers. For example, if you are -interested in packaging existing software for Debian, you should try to get a -sponsor. A sponsor will work together with you on your package and upload it -to the Debian archive once they are happy with the packaging work you have -done. You can find a sponsor by mailing the -debian-mentors@&lists-host; mailing list, describing your -package and yourself and asking for a sponsor (see -and for -more information on sponsoring). On the other hand, if you are interested in -porting Debian to alternative architectures or kernels you can subscribe to -port specific mailing lists and ask there how to get started. Finally, if you -are interested in documentation or Quality Assurance (QA) work you can join -maintainers already working on these tasks and submit patches and improvements. +When you know how you want to contribute to &debian-formal;, +you should get in contact with existing Debian maintainers who are working on +similar tasks. That way, you can learn from experienced developers. For +example, if you are interested in packaging existing software for Debian, you +should try to get a sponsor. A sponsor will work together with you on your +package and upload it to the Debian archive once they are happy with the +packaging work you have done. You can find a sponsor by mailing the +&email-debian-mentors; mailing list, describing your package +and yourself and asking for a sponsor (see and + for more information on +sponsoring). On the other hand, if you are interested in porting Debian to +alternative architectures or kernels you can subscribe to port specific mailing +lists and ask there how to get started. Finally, if you are interested in +documentation or Quality Assurance (QA) work you can join maintainers already +working on these tasks and submit patches and improvements. One pitfall could be a too-generic local part in your mailadress: Terms like @@ -65,8 +63,8 @@ url="&url-debian-lists;"> for details.
Debian mentors and sponsors -The mailing list debian-mentors@&lists-host; has been set up -for novice maintainers who seek help with initial packaging and other +The mailing list &email-debian-mentors; has been set up for +novice maintainers who seek help with initial packaging and other developer-related issues. Every new developer is invited to subscribe to that list (see for details). @@ -85,7 +83,7 @@ Those who are seeking a sponsor can request one at . --> Please read the unofficial debian-mentors FAQ at first. +url="&url-mentors;"> first. If you wish to be a mentor and/or sponsor, more information is available in @@ -96,25 +94,27 @@ If you wish to be a mentor and/or sponsor, more information is available in
Registering as a Debian developer -Before you decide to register with &debian-formal;, you will need to read all -the information available at the New Maintainer's -Corner. It describes in detail the preparations you have to do before -you can register to become a Debian developer. For example, before you apply, -you have to read the Debian -Social Contract. Registering as a developer means that you agree with -and pledge to uphold the Debian Social Contract; it is very important that -maintainers are in accord with the essential ideas behind &debian-formal;. -Reading the GNU -Manifesto would also be a good idea. +Before you decide to register with &debian-formal;, you will +need to read all the information available at the New Maintainer's Corner. It +describes in detail the preparations you have to do before you can register to +become a Debian developer. For example, before you apply, you have to read the +Debian Social +Contract. Registering as a developer means that you agree with and +pledge to uphold the Debian Social Contract; it is very important that +maintainers are in accord with the essential ideas behind +&debian-formal;. Reading the GNU Manifesto would also be +a good idea. The process of registering as a developer is a process of verifying your identity and intentions, and checking your technical skills. As the number of -people working on &debian-formal; has grown to over &number-of-maintainers; and our systems are -used in several very important places, we have to be careful about being -compromised. Therefore, we need to verify new maintainers before we can give -them accounts on our servers and let them upload packages. +people working on &debian-formal; has grown to over +&number-of-maintainers; and our systems are used in several +very important places, we have to be careful about being compromised. +Therefore, we need to verify new maintainers before we can give them accounts +on our servers and let them upload packages. Before you actually register you should have shown that you can do competent @@ -130,13 +130,13 @@ Registration requires that you are familiar with Debian's philosophy and technical documentation. Furthermore, you need a GnuPG key which has been signed by an existing Debian maintainer. If your GnuPG key is not signed yet, you should try to meet a Debian Developer in person to get your key signed. -There's a GnuPG Key Signing +There's a GnuPG Key Signing Coordination page which should help you find a Debian Developer close to you. (If there is no Debian Developer close to you, alternative ways to pass the ID check may be permitted as an absolute exception on a case-by-case-basis. See the identification page for -more information.) +url="&url-newmaint-id;">identification page for more +information.) If you do not have an OpenPGP key yet, generate one. Every developer needs an @@ -151,7 +151,7 @@ Debian uses the GNU Privacy Guard (package gnupg version 1 or better) as its baseline standard. You can use some other implementation of OpenPGP as well. Note that OpenPGP is an open standard based on RFC 2440. +url="&url-rfc2440;">RFC 2440. You need a version 4 key for use in Debian Development. Your key length must @@ -181,7 +181,7 @@ have to manually add those signatures. If your public key isn't on a public key server such as &pgp-keyserv;, please read the documentation available at -NM Step 2: +NM Step 2: Identification. That document contains instructions on how to put your key on the public key servers. The New Maintainer Group will put your public key on the servers if it isn't already there. @@ -204,7 +204,7 @@ has to express their belief that you can contribute to Debian successfully. When you have found an advocate, have your GnuPG key signed and have already contributed to Debian for a while, you're ready to apply. You can simply -register on our application +register on our application page. After you have signed up, your advocate has to confirm your application. When your advocate has completed this step you will be assigned an Application Manager who will go with you through the necessary steps of the @@ -213,10 +213,10 @@ url="&url-newmaint-db;">applications status board. For more details, please consult New Maintainer's Corner -at the Debian web site. Make sure that you are familiar with the necessary -steps of the New Maintainer process before actually applying. If you are well -prepared, you can save a lot of time later on. +url="&url-newmaint;">New Maintainer's Corner at the +Debian web site. Make sure that you are familiar with the necessary steps of +the New Maintainer process before actually applying. If you are well prepared, +you can save a lot of time later on.
diff --git a/pkgs.dbk b/pkgs.dbk index fdf7a0f..f63c344 100644 --- a/pkgs.dbk +++ b/pkgs.dbk @@ -1,7 +1,7 @@ %commondata; + %commondata; ]> Managing Packages @@ -32,8 +32,8 @@ You should set the subject of the bug to ``ITP: foo -- short description'', substituting the name of the new package for foo. The severity of the bug report must be set to wishlist. If you feel it's necessary, send -a copy to debian-devel@&lists-host; by putting the address -in the X-Debbugs-CC: header of the message (no, don't use +a copy to &email-debian-devel; by putting the address in the +X-Debbugs-CC: header of the message (no, don't use CC:, because that way the message's subject won't indicate the bug number). @@ -338,10 +338,10 @@ packages uninstallable, is strongly discouraged. The Release Team (which can be reached at -debian-release@&lists-host;) will regularly evaluate the -uploads To stable-proposed-updates and decide if your -package can be included in stable. Please be clear (and -verbose, if necessary) in your changelog entries for uploads to +&email-debian-release;) will regularly evaluate the uploads To +stable-proposed-updates and decide if your package can be +included in stable. Please be clear (and verbose, if +necessary) in your changelog entries for uploads to stable, because otherwise the package won't be considered for inclusion. @@ -512,10 +512,10 @@ file. To alter the actual section that a package is put in, you need to first make sure that the debian/control file in your package is -accurate. Next, send an email override-change@debian.org or -submit a bug against &ftp-debian-org; -requesting that the section or priority for your package be changed from the -old section or priority to the new one. Be sure to explain your reasoning. +accurate. Next, send an email &email-override; or submit a +bug against ftp.debian.org requesting +that the section or priority for your package be changed from the old section +or priority to the new one. Be sure to explain your reasoning. For more information about override files, see @@ -565,10 +565,10 @@ can check them by browsing this page: Maintainers interact with the BTS via email addresses at -&bugs-host;. Documentation on available commands can be -found at , or, if you have -installed the doc-debian package, you -can look at the local files /usr/share/doc/debian/bug-*. +&bugs-host;. Documentation on available +commands can be found at , or, +if you have installed the doc-debian +package, you can look at the local files &file-bts-docs;. Some find it useful to get periodic reports on open bugs. You can add a cron @@ -609,9 +609,9 @@ linkend="upload-bugfix"/> . You should never close bugs via the bug server -close command sent to -control@&bugs-host;. If you do so, the original submitter -will not receive any information about why the bug was closed. +close command sent to &email-bts-control;. +If you do so, the original submitter will not receive any information about why +the bug was closed.
@@ -657,7 +657,7 @@ unacceptable, you (or the submitter) may want to require a decision of the technical committee by reassigning the bug to tech-ctte (you may use the clone command of the BTS if you wish to keep it reported against your package). Before doing so, please -read the recommended +read the recommended procedure. @@ -666,7 +666,7 @@ procedure. If the bug is real but it's caused by another package, just reassign the bug to the right package. If you don't know which package it should be reassigned to, you should ask for help on IRC or -on debian-devel@&lists-host;. Please make sure that the +on &email-debian-devel;. Please make sure that the maintainer(s) of the package the bug is reassigned to know why you reassigned it. @@ -703,14 +703,14 @@ someone, the bug may be closed. If the bug is related to the packaging, you just fix it. If you are not able to fix it yourself, then tag the bug as help. You can also -ask for help on debian-devel@&lists-host; or -debian-qa@&lists-host;. If it's an upstream problem, you -have to forward it to the upstream author. Forwarding a bug is not enough, you -have to check at each release if the bug has been fixed or not. If it has, you -just close it, otherwise you have to remind the author about it. If you have -the required skills you can prepare a patch that fixes the bug and send it to -the author at the same time. Make sure to send the patch to the BTS and to tag -the bug as patch. +ask for help on &email-debian-devel; or +&email-debian-qa;. If it's an upstream problem, you have to +forward it to the upstream author. Forwarding a bug is not enough, you have to +check at each release if the bug has been fixed or not. If it has, you just +close it, otherwise you have to remind the author about it. If you have the +required skills you can prepare a patch that fixes the bug and send it to the +author at the same time. Make sure to send the patch to the BTS and to tag the +bug as patch. @@ -784,7 +784,7 @@ If you happen to mistype a bug number or forget a bug in the changelog entries, don't hesitate to undo any damage the error caused. To reopen wrongly closed bugs, send a reopen XXX command to the bug tracking system's control address, -control@&bugs-host;. To close any remaining bugs that were +&email-bts-control;. To close any remaining bugs that were fixed by your upload, email the .changes file to XXX-done@&bugs-host;, where XXX is the bug number, and put Version: YYY and an empty line as the first two @@ -820,7 +820,7 @@ security.debian.org. When you become aware of a security-related bug in a Debian package, whether or not you are the maintainer, collect pertinent information about the problem, and promptly contact the security team at -team@security.debian.org as soon as possible. DO NOT UPLOAD any packages for stable; the security team will do that. Useful information includes, for example: @@ -933,8 +933,8 @@ has become public. Security advisories are only issued for the current, released stable distribution, and not for testing or unstable. When released, advisories are sent to the -debian-security-announce@&lists-host; mailing list and -posted on the security web +&email-debian-security-announce; mailing list and posted on +the security web page. Security advisories are written and posted by the security team. However they certainly do not mind if a maintainer can supply some of the information for them, or write part of the text. Information that should be in @@ -1222,7 +1222,7 @@ described in . If for some reason you want to completely remove a package (say, if it is an old compatibility library which is no longer required), you need to file a bug -against &ftp-debian-org; asking that the package be removed; +against ftp.debian.org asking that the package be removed; as all bugs, this bug should normally have normal severity. Make sure you indicate which distribution the package should be removed from. Normally, you can only have packages removed from unstable and @@ -1259,14 +1259,14 @@ and . If in doubt concerning whether a package is disposable, email -debian-devel@&lists-host; asking for opinions. Also of -interest is the apt-cache program from the apt-cache program from the apt package. When invoked as apt-cache showpkg package, the program will show details for package, including reverse depends. Other useful programs include apt-cache rdepends, apt-rdepends and grep-dctrl. Removal of -orphaned packages is discussed on debian-qa@&lists-host;. +orphaned packages is discussed on &email-debian-qa;. Once the package has been removed, the package's bugs should be handled. They @@ -1300,7 +1300,7 @@ process to rename it. First, set your debian/control file to replace and conflict with the obsolete name of the package (see the Debian Policy Manual for details). Once you've uploaded the package and the package has moved into the -archive, file a bug against &ftp-debian-org; asking to remove +archive, file a bug against ftp.debian.org asking to remove the package with the obsolete name. Do not forget to properly reassign the package's bugs at the same time. @@ -1323,15 +1323,15 @@ mirror network. If you can no longer maintain a package, you need to inform others, and see that the package is marked as orphaned. You should set the package maintainer -to Debian QA Group <&pts-host;> and submit -a bug report against the pseudo package Debian QA Group &orphan-address; and +submit a bug report against the pseudo package wnpp. The bug report should be titled O: package -- short description indicating that the package is now orphaned. The severity of the bug should be set to normal; if the package has a priority of standard or higher, it should be set to important. If you feel it's necessary, send a copy -to debian-devel@&lists-host; by putting the address in the +to &email-debian-devel; by putting the address in the X-Debbugs-CC: header of the message (no, don't use CC:, because that way the message's subject won't indicate the bug number). @@ -1371,8 +1371,8 @@ package. Complaints about maintainers should be brought up on the developers' mailing list. If the discussion doesn't end with a positive conclusion, and the issue is of a technical nature, consider bringing it to the attention of the technical committee (see the technical committee web -page for more information). +url="&url-tech-ctte;">technical committee web page for +more information). If you take over an old package, you probably want to be listed as the @@ -1758,7 +1758,7 @@ architectures: A porter or any other person trying to build your package might accidently upload it without noticing it doesn't work. If in the past some binary packages were uploaded on unsupported architectures, request their removal by filing a bug against &ftp-debian-org; +role="package">ftp.debian.org @@ -2032,8 +2032,8 @@ Unless you know the maintainer is still active, it is wise to check the package to see if it has been orphaned. The current list of orphaned packages which haven't had their maintainer set correctly is available at . If you perform an NMU on an -improperly orphaned package, please set the maintainer to ``Debian QA Group -<&pts-host;>''. +improperly orphaned package, please set the maintainer to Debian QA Group +<packages@qa.debian.org>. @@ -2238,7 +2238,7 @@ all the necessary criteria); To find out whether a package is progressing into testing or not, see the testing script output on the web page of the testing +url="&url-testing-maint;">web page of the testing distribution, or use the program grep-excuses which is in the devscripts package. This utility can easily be used in a @@ -2250,7 +2250,7 @@ to keep yourself informed of the progression of your packages into The update_excuses file does not always give the precise reason why the package is refused; you may have to find it on your own by looking for what would break with the inclusion of the package. The testing web page gives some +url="&url-testing-maint;">testing web page gives some more information about the usual problems which may be causing such troubles. @@ -2403,8 +2403,8 @@ considered for update. Currently, this requires some manual hinting from the release team. Please -contact them by sending mail to debian-release@&lists-host; -if this happens to one of your packages. +contact them by sending mail to &email-debian-release; if this +happens to one of your packages. @@ -2477,7 +2477,7 @@ Keep in mind that packages uploaded there are not automatically processed, they have to go through the hands of the release manager. So you'd better have a good reason to upload there. In order to know what a good reason is in the release managers' eyes, you should read the instructions that they regularly -give on debian-devel-announce@&lists-host;. +give on &email-debian-devel-announce;. You should not upload to testing-proposed-updates when you @@ -2535,8 +2535,7 @@ and lower than in unstable; After uploading and successful build on all platforms, contact the release team -at debian-release@&lists-host; and ask them to approve your -upload. +at &email-debian-release; and ask them to approve your upload. diff --git a/resources.dbk b/resources.dbk index 373bc55..8a00891 100644 --- a/resources.dbk +++ b/resources.dbk @@ -1,7 +1,7 @@ %commondata; + %commondata; ]> Resources for Debian Developers @@ -15,12 +15,13 @@ all the other resources that are available to help you in your maintainer work. Much of the conversation between Debian developers (and users) is managed through a wide array of mailing lists we host at &lists-host;. To find out -more on how to subscribe or unsubscribe, how to post and how not to post, where -to find old posts and how to search them, how to contact the list maintainers -and see various other information about the mailing lists, please read . This section will only -cover aspects of mailing lists that are of particular interest to developers. +url="http://&lists-host;/">&lists-host;. +To find out more on how to subscribe or unsubscribe, how to post and how not to +post, where to find old posts and how to search them, how to contact the list +maintainers and see various other information about the mailing lists, please +read . This section +will only cover aspects of mailing lists that are of particular interest to +developers.
Basic rules for use @@ -50,27 +51,27 @@ The core Debian mailing lists that developers should use are: -debian-devel-announce@&lists-host;, used to announce -important things to developers. All developers are expected to be subscribed -to this list. +&email-debian-devel-announce;, used to announce important +things to developers. All developers are expected to be subscribed to this +list. -debian-devel@&lists-host;, used to discuss various -development related technical issues. +&email-debian-devel;, used to discuss various development +related technical issues. -debian-policy@&lists-host;, where the Debian Policy is -discussed and voted on. +&email-debian-policy;, where the Debian Policy is discussed +and voted on. -debian-project@&lists-host;, used to discuss various -non-technical issues related to the project. +&email-debian-project;, used to discuss various non-technical +issues related to the project. @@ -83,11 +84,11 @@ There are other mailing lists available for a variety of special topics; see
Special lists -debian-private@&lists-host; is a special mailing list for -private discussions amongst Debian developers. It is meant to be used for -posts which for whatever reason should not be published publicly. As such, it -is a low volume list, and users are urged not to use -debian-private@&lists-host; unless it is really necessary. +&email-debian-private; is a special mailing list for private +discussions amongst Debian developers. It is meant to be used for posts which +for whatever reason should not be published publicly. As such, it is a low +volume list, and users are urged not to use +&email-debian-private; unless it is really necessary. Moreover, do not forward email from that list to anyone. Archives of this list are not available on the web for obvious reasons, but you can see them using your shell account on &lists-host; @@ -95,10 +96,10 @@ and looking in the &file-debian-private-archive; directory. -debian-email@&lists-host; is a special mailing list used as -a grab-bag for Debian related correspondence such as contacting upstream -authors about licenses, bugs, etc. or discussing the project with others where -it might be useful to have the discussion archived somewhere. +&email-debian-email; is a special mailing list used as a +grab-bag for Debian related correspondence such as contacting upstream authors +about licenses, bugs, etc. or discussing the project with others where it +might be useful to have the discussion archived somewhere.
@@ -125,7 +126,7 @@ url="&url-debian-lists-new;">the HOWTO. IRC channels Several IRC channels are dedicated to Debian's development. They are mainly -hosted on the Open and free technology +hosted on the Open and free technology community (OFTC) network. The irc.debian.org DNS entry is an alias to irc.oftc.net. @@ -148,12 +149,12 @@ information for developers. Since #debian-devel is an open channel, you should not speak there of issues that are discussed in -debian-private@&lists-host;. There's another channel for -this purpose, it's called #debian-private and it's -protected by a key. This key is available in the archives of debian-private in -master.debian.org:&file-debian-private-archive;, just -zgrep for #debian-private in all the -files. +&email-debian-private;. There's another channel for this +purpose, it's called #debian-private and it's protected by +a key. This key is available in the archives of debian-private in +master.debian.org:&file-debian-private-archive;, +just zgrep for #debian-private in all +the files. There are other additional channels dedicated to specific subjects. @@ -174,8 +175,9 @@ Debian's development. Channels dedicated to Debian also exist on other IRC networks, notably on the -freenode IRC network, which was -pointed at by the irc.debian.org alias until 4th June 2006. +freenode IRC network, +which was pointed at by the irc.debian.org alias until 4th +June 2006. To get a cloak on freenode, you send Jörg Jaspert <joerg@debian.org> a @@ -209,7 +211,7 @@ activities, and they all have a permanent connection to the Internet. Most of the machines are available for individual developers to use, as long as the developers follow the rules set forth in the Debian Machine Usage Policies. +url="&url-dmup;">Debian Machine Usage Policies. Generally speaking, you can use these machines for Debian-related purposes as @@ -253,8 +255,8 @@ mirrored to another server.
The bugs server -&bugs-host; is the canonical location for the Bug -Tracking System (BTS). +&bugs-host; is the canonical location for +the Bug Tracking System (BTS). It is restricted; a mirror is available on merkel. @@ -262,8 +264,8 @@ It is restricted; a mirror is available on merkel. If you plan on doing some statistical analysis or processing of Debian bugs, this would be the place to do it. Please describe your plans on -debian-devel@&lists-host; before implementing anything, -however, to reduce unnecessary duplication of effort or wasted processing time. +&email-debian-devel; before implementing anything, however, to +reduce unnecessary duplication of effort or wasted processing time.
@@ -280,7 +282,7 @@ It is restricted; a mirror is available on merkel. Problems with the Debian FTP archive generally need to be reported as bugs against the &ftp-debian-org; -pseudo-package or an email to ftpmaster@debian.org, but also see +pseudo-package or an email to &email-ftpmaster;, but also see the procedures in .
@@ -303,7 +305,7 @@ official web pages, the face of Debian for most newbies. If you find a problem with the Debian web server, you should generally submit a bug against the pseudo-package, &www-debian-org;. Remember to check whether or not +role="package">www.debian.org. Remember to check whether or not someone else has already reported the problem to the Bug Tracking System. @@ -332,8 +334,7 @@ materials subject to the U.S. export restrictions, in which case you can use one of the other servers located outside the United States. -Send mail to debian-devel@&lists-host; if you have any -questions. +Send mail to &email-debian-devel; if you have any questions. @@ -356,7 +357,7 @@ via the Web at . To request a CVS area, send a request via email to -debian-admin@debian.org. Include the name of the requested CVS +&email-debian-admin;. Include the name of the requested CVS area, the Debian account that should own the CVS root area, and why you need it. @@ -384,11 +385,12 @@ out which chroots are available via
The Developers Database -The Developers Database, at , is an -LDAP directory for managing Debian developer attributes. You can use this -resource to search the list of Debian developers. Part of this information is -also available through the finger service on Debian servers, try -finger yourlogin@db.debian.org to see what it reports. +The Developers Database, at , is an LDAP directory for +managing Debian developer attributes. You can use this resource to search the +list of Debian developers. Part of this information is also available through +the finger service on Debian servers, try finger +yourlogin@db.debian.org to see what it reports. Developers can log into the @@ -414,7 +416,7 @@ whether you are on vacation personal information such as your address, country, the latitude and longitude of the place where you live for use in the world map of Debian +url="&url-worldmap;">the world map of Debian developers, phone and fax numbers, IRC nickname and web page @@ -441,8 +443,9 @@ url="&url-debian-db-mail-gw;">. The Debian archive The &debian-formal; distribution consists of a lot of packages -(.deb's, currently around &number-of-pkgs;) and a few additional files -(such as documentation and installation disk images). +(.deb's, currently around +&number-of-pkgs;) and a few additional files (such as +documentation and installation disk images). Here is an example directory tree of a complete Debian archive: @@ -831,9 +834,9 @@ push mirroring). All the information on Debian mirrors, including a list of the available public FTP/HTTP servers, can be found at . This useful page also includes -information and tools which can be helpful if you are interested in setting up -your own mirror, either for internal or public access. +url="&url-debian-mirrors;">. This useful page also +includes information and tools which can be helpful if you are interested in +setting up your own mirror, either for internal or public access. Note that mirrors are generally run by third-parties who are interested in @@ -872,7 +875,7 @@ package is refused and is moved to the reject directory. Once the package is accepted, the system sends a confirmation mail to the maintainer and closes all the bugs marked as fixed by the upload, and the auto-builders may start recompiling it. The package is now publicly accessible -at until it is really +at until it is really installed in the Debian archive. This happens only once a day (and is also called the `dinstall run' for historical reasons); the package is then removed from incoming and installed in the pool along with all the other packages. @@ -885,10 +888,10 @@ The archive maintenance software will also send the OpenPGP/GnuPG signed .changes file that you uploaded to the appropriate mailing lists. If a package is released with the Distribution: set to `stable', the announcement is sent to -debian-changes@&lists-host;. If a package is released with +&email-debian-changes;. If a package is released with Distribution: set to `unstable' or `experimental', the -announcement will be posted to -debian-devel-changes@&lists-host; instead. +announcement will be posted to &email-debian-devel-changes; +instead. Though ftp-master is restricted, a copy of the installation is available to all @@ -1178,7 +1181,7 @@ summary: bts-control: reply to mails sent to -control@&bugs-host; +&email-bts-control; @@ -1474,12 +1477,12 @@ contained in the previous one. Developer's packages overview A QA (quality assurance) web portal is available at which displays a table -listing all the packages of a single developer (including those where the party -is listed as a co-maintainer). The table gives a good summary about the -developer's packages: number of bugs by severity, list of available versions in -each distribution, testing status and much more including links to any other -useful information. +url="&url-ddpo;"> which displays a table listing all +the packages of a single developer (including those where the party is listed +as a co-maintainer). The table gives a good summary about the developer's +packages: number of bugs by severity, list of available versions in each +distribution, testing status and much more including links to any other useful +information. It is a good idea to look up your own data regularly so that you don't forget @@ -1510,7 +1513,7 @@ request guest accounts on Alioth. For more information please visit . +url="&url-alioth;">.
diff --git a/scope.dbk b/scope.dbk index ea7b71a..c990b1e 100644 --- a/scope.dbk +++ b/scope.dbk @@ -1,7 +1,7 @@ %commondata; + %commondata; ]> Scope of This Document @@ -31,8 +31,8 @@ maintainers with the quality of their packages ( ). It should be clear that this reference does not discuss the technical details of Debian packages nor how to generate them. Nor does this reference detail the standards to which Debian software must comply. All of such information -can be found in the Debian Policy Manual. +can be found in the Debian +Policy Manual. Furthermore, this document is not an expression of formal diff --git a/tools.dbk b/tools.dbk index 25d61a0..1590c75 100644 --- a/tools.dbk +++ b/tools.dbk @@ -1,7 +1,7 @@ %commondata; + %commondata; ]> Overview of Debian Maintainer Tools @@ -26,7 +26,7 @@ exclusion of a competing tool. Most of the descriptions of these packages come from the actual package descriptions themselves. Further information can be found in the package documentation itself. You can also see more info with the command -apt-cache show <package-name>. +apt-cache show <package-name>.
Core tools