From: taffit-guest Date: Sat, 5 Jun 2010 14:08:56 +0000 (+0000) Subject: Minor changes: tags, typos, links and other cosmetic changes. X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=developers-reference.git;a=commitdiff_plain;h=81c0e6409c7dfef4af519821a76dbfadb7dd4758 Minor changes: tags, typos, links and other cosmetic changes. git-svn-id: svn://anonscm.debian.org/ddp/manuals/trunk/developers-reference@7381 313b444b-1b9f-4f58-a734-7bb04f332e8d --- diff --git a/best-pkging-practices.dbk b/best-pkging-practices.dbk index c436c6f..08a425d 100644 --- a/best-pkging-practices.dbk +++ b/best-pkging-practices.dbk @@ -567,9 +567,9 @@ inserting the title of each different bug. Important news about changes in a package can also be put in NEWS.Debian files. -The news will be displayed by tools like apt-listchanges, before all the rest +The news will be displayed by tools like apt-listchanges, before all the rest of the changelogs. This is the preferred means to let the user know about -significant changes in a package. It is better than using debconf notes since +significant changes in a package. It is better than using debconf notes since it is less annoying and the user can go back and refer to the NEWS.Debian file after the install. And it's better than listing major changes in README.Debian, since the user can easily diff --git a/beyond-pkging.dbk b/beyond-pkging.dbk index b43eda4..cafbbd3 100644 --- a/beyond-pkging.dbk +++ b/beyond-pkging.dbk @@ -64,7 +64,7 @@ From time to time you may want to check what has been going on with the bug reports that you submitted. Take this opportunity to close those that you can't reproduce anymore. To find out all the bugs you submitted, you just have to visit -http://&bugs-host;/from:<your-email-addr>. +http://&bugs-host;/from:your-email-addr.
Reporting lots of bugs at once (mass bug filing) @@ -85,7 +85,7 @@ several maintainers start filing the same bug report simultaneously. Please use the programs dd-list and if appropriate -whodepends (from the package devscripts) to generate a list +whodepends (from the package devscripts) to generate a list of all affected packages, and include the output in your mail to &email-debian-devel;. @@ -109,24 +109,24 @@ To add usertags when filing bugs, specify the User and To: submit@bugs.debian.org -Subject: <title-of-bug> +Subject: title-of-bug -Package: <pkgname> +Package: pkgname [ ... ] -User: <email-addr> -Usertags: <tag-name> [ <tag-name> ... ] +User: email-addr +Usertags: tag-name [ tag-name ... ] -<description-of-bug ...> +description-of-bug ... Note that tags are seperated by spaces and cannot contain underscores. If you -are filing bugs for for a particular group or team it is recommended that you +are filing bugs for a particular group or team it is recommended that you set the User to an appropriate mailing list after describing your intention there. To view bugs tagged with a specific usertag, visit -http://&bugs-host;/cgi-bin/pkgreport.cgi?users=<email-addr>&tag=<tag-name>. +http://&bugs-host;/cgi-bin/pkgreport.cgi?users=email-addr&tag=tag-name.
@@ -141,13 +141,13 @@ To view bugs tagged with a specific usertag, visit Even though there is a dedicated group of people for Quality Assurance, QA duties are not reserved solely for them. You can participate in this effort by keeping your packages as bug-free as possible, and as lintian-clean (see ) as possible. If you do not find that possible, then you +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 +linkend="orphaning"/>). 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 &email-debian-qa; or &email-debian-devel;). At the same time, you can look for -co-maintainers (see ). +co-maintainers (see ). @@ -197,15 +197,15 @@ version is available and that you need it. Looking up the email address of the maintainer for the package can be distracting. Fortunately, there is a simple email alias, -<package>@&packages-host;, which provides a way to +package@&packages-host;, which provides a way to email the maintainer, whatever their individual email address (or addresses) -may be. Replace <package> with the name of a source +may be. Replace package with the name of a source or a binary package. You may also be interested in contacting the persons who are subscribed to a -given source package via . You can do so -by using the <package>@&pts-host; email +given source package via . You can do so +by using the package@&pts-host; email address. @@ -225,8 +225,8 @@ There is a simple system (the MIA database) in which information about maintainers who are deemed Missing In Action is recorded. When a member of the QA group contacts an inactive maintainer or finds more information about one, this is recorded in the MIA database. This system is available in -/org/qa.debian.org/mia on the host qa.debian.org -, and can be queried with the mia-query tool. +/org/qa.debian.org/mia on the host qa.debian.org, +and can be queried with the mia-query tool. Use mia-query --help to see how to query the database. If you find that no information has been recorded about an inactive maintainer yet, or that you can add more information, you should generally proceed as follows. @@ -308,8 +308,8 @@ 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 +README file in /org/qa.debian.org/mia on +qa.debian.org where the technical details and the MIA procedures are documented and contact &email-mia;. @@ -369,7 +369,7 @@ In theory, you should only ask for the diff file and the location of the original source tarball, and then you should download the source and apply the diff yourself. In practice, you may want to use the source package built by your sponsoree. In that case, you have to check that they haven't altered the -upstream files in the .orig.tar.gz file that they're +upstream files in the .orig.tar.{gz,bz2,lzma} file that they're providing. @@ -389,7 +389,7 @@ part of your KEY-ID, as long as it's unique in your secret keyring. -The Maintainer field of the control file and the +The Maintainer field of the control file and the changelog should list the person who did the packaging, i.e., the sponsoree. The sponsoree will therefore get all the BTS mail about the package. @@ -400,7 +400,7 @@ add a line stating it in the most recent changelog entry. You are encouraged to keep tabs on the package you sponsor using . +linkend="pkg-tracking-system"/>. diff --git a/common.ent b/common.ent index d041c82..c33b9cf 100644 --- a/common.ent +++ b/common.ent @@ -80,13 +80,18 @@ - + + + + + + @@ -104,9 +109,6 @@ - - - @@ -123,6 +125,9 @@ + + + listmaster@&lists-host;"> @@ -145,7 +150,7 @@ debian-security-announce@&lists-host;"> debian-l10n-english@&lists-host;"> mia@qa.debian.org"> - +keyring@rt.debian.org"> admin@rt.debian.org"> ftpmaster@debian.org"> control@&bugs-host;"> diff --git a/developer-duties.dbk b/developer-duties.dbk index b2d375f..b753160 100644 --- a/developer-duties.dbk +++ b/developer-duties.dbk @@ -26,7 +26,7 @@ For more information about the database, please see 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 +linkend="server-machines"/>). Back your keys up; keep a copy offline. Read the documentation that comes with your software; read the PGP FAQ. @@ -100,7 +100,7 @@ duties in the project. Usually this means that other developers are allowed to NMU (see ) your package if a big problem (release critical bug, security +linkend="nmu"/>) your package if a big problem (release critical bug, security update, etc.) occurs while you're on vacation. Sometimes it's nothing as critical as that, but it's still appropriate to let others know that you're unavailable. @@ -122,7 +122,7 @@ the on vacation flag when you come back! Ideally, you should sign up at the GPG coordination site when booking a +url="&url-gpg-coord;">GPG coordination pages when booking a holiday and check if anyone there is looking for signing. This is especially important when people go to exotic places where we don't have any developers yet but where there are people who are interested in applying. @@ -164,7 +164,7 @@ Debian community is not worth the benefits the software may bring. Managing release-critical bugs Generally you should deal with bug reports on your packages as described in - . However, there's a special category of bugs +. However, there's a special category of bugs that you need to take care of — the so-called release-critical bugs (RC bugs). All bug reports that have severity critical, grave or serious are considered to @@ -182,7 +182,7 @@ mail to the Quality Assurance (QA) group debian-qa@&lists-host;, or explain your difficulties and present a plan to fix them by sending a mail to the bug report. Otherwise, people from the QA group may want to do a Non-Maintainer Upload (see ) after trying to contact you (they might not wait as long as +linkend="nmu"/>) after trying to contact you (they might not wait as long as usual before they do their NMU if they have seen no recent activity from you in the BTS). @@ -197,7 +197,7 @@ following steps: -Orphan all your packages, as described in . +Orphan all your packages, as described in . @@ -209,7 +209,7 @@ Send an gpg-signed email about why you are leaving the project to Notify the Debian key ring maintainers that you are leaving by opening a ticket -in Debian RT by sending a mail to keyring@rt.debian.org with the words 'Debian +in Debian RT by sending a mail to &email-keyring; with the words 'Debian RT' somewhere in the subject line (case doesn't matter). diff --git a/l10n.dbk b/l10n.dbk index e87276d..a089e64 100644 --- a/l10n.dbk +++ b/l10n.dbk @@ -15,7 +15,7 @@ programs, you should read most of this chapter. According to Introduction to +url="&url-i18n-intro;">Introduction to i18n from Tomohiro KUBOTA, I18N (internationalization) means modification of a software or related technologies so that a software can potentially handle multiple languages, customs, and so on in the world, while @@ -45,12 +45,12 @@ task, and the process depends on the kind of text you want to see translated. For program messages, the gettext infrastructure is used most of the time. Most of the time, the translation is handled upstream within projects like the -Free Translation +Free Translation Project, the Gnome translation -Project or the KDE one. The +url="&url-l10n-gnome;">Gnome translation +Project or the KDE one. The only centralized resource within Debian is the Central Debian translation +url="&url-l10n;">Central Debian translation statistics, where you can find some statistics about the translation files found in the actual packages, but no real infrastructure to ease the translation process. @@ -60,23 +60,24 @@ An effort to translate the package descriptions started long ago, even if very little support is offered by the tools to actually use them (i.e., only APT can use them, when configured correctly). Maintainers don't need to do anything special to support translated package descriptions; translators should use the -DDTP. +Debian Description Translation Project (DDTP). -For debconf templates, maintainers should use the po-debconf package to ease +For debconf templates, maintainers +should use the po-debconf package to ease the work of translators, who could use the DDTP to do their work (but the French and Brazilian teams don't). Some statistics can be found both on the -DDTP site (about what is actually translated), and on the Central Debian translation +DDTP site (about what is actually translated), +and on the Central Debian translation statistics site (about what is integrated in the packages). -For web pages, each l10n team has access to the relevant CVS, and the +For web pages, each l10n team has access to the relevant VCS, and the statistics are available from the Central Debian translation statistics site. For general documentation about Debian, the process is more or less the same as -for the web pages (the translators have access to the CVS), but there are no +for the web pages (the translators have access to the VCS), but there are no statistics pages. @@ -89,7 +90,7 @@ same way as its program messages. There is an effort to handle Debian-specific man pages within a specific CVS +url="&url-cvsweb;manpages/?cvsroot=debian-doc">specific VCS repository. @@ -106,7 +107,7 @@ your feedback, so that this document can be enhanced.
How to get a given text translated -To translate package descriptions or debconf templates, you have nothing to do; +To translate package descriptions or debconf templates, you have nothing to do; the DDTP infrastructure will dispatch the material to translate to volunteers with no need for interaction from your part. @@ -207,7 +208,7 @@ from running. As a maintainer, never edit the translations in any way (even to reformat the layout) without asking on the corresponding l10n mailing list. You risk for -example breaksing the encoding of the file by doing so. Moreover, what you +example breaking the encoding of the file by doing so. Moreover, what you consider an error can be right (or even needed) in the given language. diff --git a/new-maintainer.dbk b/new-maintainer.dbk index cc23449..dc514d0 100644 --- a/new-maintainer.dbk +++ b/new-maintainer.dbk @@ -21,7 +21,7 @@ already. Send the word subscribe in the Subject of an email to &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 . +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. @@ -34,7 +34,7 @@ something to avoid duplicated effort. Another good list to subscribe to is &email-debian-mentors;. See for details. The IRC channel #debian can also be helpful; see . +linkend="irc-channels"/>. When you know how you want to contribute to &debian-formal;, @@ -87,7 +87,7 @@ url="&url-mentors;"> first. If you wish to be a mentor and/or sponsor, more information is available in - . +.
@@ -147,7 +147,7 @@ human error than to software failure or high-powered spy techniques. See for more information on maintaining your public key. -Debian uses the GNU Privacy Guard (package 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 apt-cache show <package-name>. +apt-cache show package-name.
Core tools @@ -58,7 +58,7 @@ role="package">debconf-doc package. Many feel that this system should be used for all packages which require -interactive configuration; see . . debconf is not currently required by Debian Policy, but that may change in the future. @@ -113,10 +113,10 @@ latest lintian output for the whole development distribution
-<systemitem role="package">debdiff</systemitem> +<command>debdiff</command> debdiff (from the devscripts package, ) +role="package">devscripts package, ) compares file lists and control files of two packages. It is a simple regression test, as it will help you notice if the number of binary packages has changed since the last upload, or if something has changed in the control @@ -182,7 +182,7 @@ The dh-make package contains dh_make, a program that creates a skeleton of files necessary to build a Debian package out of a source tree. As the name suggests, dh_make is a rewrite of debmake and its template files use dh_* programs +role="package">debmake and its template files use dh_* programs from debhelper. @@ -206,8 +206,8 @@ files. There is possibility to use macro engine similar to the one used in SPECS files from RPM source packages. -For more informations see YADA site. +For more informations see YADA site.
@@ -321,10 +321,10 @@ signature and checksums before uploading, and the possibility of running
-<systemitem role="package">dcut</systemitem> +<command>dcut</command> -The dcut script (part of the package - ) helps in removing files from the ftp upload directory. +The dcut script (part of the package dput, +) helps in removing files from the ftp upload directory.
@@ -415,10 +415,10 @@ latest entry in a debian/changelog file.
-<systemitem role="package">dpkg-depcheck</systemitem> +<command>dpkg-depcheck</command> dpkg-depcheck (from the devscripts package, ) +role="package">devscripts package, ) runs a command under strace to determine all the packages that were used by the said command. @@ -433,7 +433,9 @@ dpkg-depcheck -b debian/rules build dpkg-depcheck can also be used to check for run-time -dependencies, especially if your package uses exec(2) to run other programs. +dependencies, especially if your package uses +exec 2 +to run other programs. For more information please see