From fc34d7250f853440f2e1a9e89c5fd34419ee0f40 Mon Sep 17 00:00:00 2001 From: taffit-guest Date: Mon, 31 May 2010 23:19:56 +0000 Subject: [PATCH] Minor changes: tags, typos, updates and other cosmetic changes git-svn-id: svn://anonscm.debian.org/ddp/manuals/trunk/developers-reference@7377 313b444b-1b9f-4f58-a734-7bb04f332e8d --- best-pkging-practices.dbk | 200 ++++++++++++++++---------------- common.ent | 3 +- new-maintainer.dbk | 2 +- pkgs.dbk | 233 +++++++++++++++++++------------------- resources.dbk | 2 +- 5 files changed, 222 insertions(+), 218 deletions(-) diff --git a/best-pkging-practices.dbk b/best-pkging-practices.dbk index 32d5115..ca9f149 100644 --- a/best-pkging-practices.dbk +++ b/best-pkging-practices.dbk @@ -67,7 +67,7 @@ You can get started with debhelper by reading debhelper 1 , and looking at the examples that come with the package. dh_make, from the dh-make package (see ), +role="package">dh-make package (see ), can be used to convert a vanilla source package to a debhelperized package. This shortcut, though, should not convince you that you do not need to bother understanding the @@ -225,7 +225,7 @@ repeating the package name, but also informative. The synopsis functions as a phrase describing the package, not a complete sentence, so sentential punctuation is inappropriate: it does not need extra capital letters or a final period (full stop). It should also omit any initial -indefinite or definite article - "a", "an", or "the". Thus for instance: +indefinite or definite article — "a", "an", or "the". Thus for instance: Package: libeg0 @@ -233,8 +233,8 @@ Description: exemplification support library Technically this is a noun phrase minus articles, as opposed to a verb phrase. -A good heuristic is that it should be possible to substitute the package name -and synopsis into this formula: +A good heuristic is that it should be possible to substitute the package +name and synopsis into this formula: The package name provides {a,an,the,some} @@ -482,7 +482,7 @@ file. The only bugs closed with a changelog entry should be those that are actually fixed in the same package revision. Closing unrelated bugs in the changelog is -bad practice. See . +bad practice. See . The changelog entries should not be used for @@ -563,15 +563,15 @@ inserting the title of each different bug.
-Supplementing changelogs with NEWS.Debian files +Supplementing changelogs with <filename>NEWS.Debian</filename> files -Important news about changes in a package can also be put in -NEWS.Debian files. +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 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 -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 +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 miss such notes. @@ -581,8 +581,8 @@ asterisks and describe each news item with a full paragraph when necessary rather than the more concise summaries that would go in a changelog. It's a good idea to run your file through dpkg-parsechangelog to check its formatting as it will not be automatically checked during build as -the changelog is. Here is an example of a real NEWS.Debian - file: +the changelog is. Here is an example of a real +NEWS.Debian file: cron (3.0pl1-74) unstable; urgency=low @@ -595,11 +595,11 @@ cron (3.0pl1-74) unstable; urgency=low -- Steve Greenland <stevegr@debian.org> Sat, 6 Sep 2003 17:15:03 -0500 -The NEWS.Debian file is installed as -/usr/share/doc/package/NEWS.Debian.gz. +The NEWS.Debian file is installed as +/usr/share/doc/package/NEWS.Debian.gz. It is compressed, and always has that name even in Debian native packages. -If you use debhelper, dh_installchangelogs - will install debian/NEWS files for you. +If you use debhelper, dh_installchangelogs +will install debian/NEWS files for you. Unlike changelog files, you need not update NEWS.Debian @@ -673,7 +673,7 @@ the following POSIX-compliant shell function may help: &example-pathfind; -You can use this function to search $PATH for a command +You can use this function to search $PATH for a command name, passed as an argument. It returns true (zero) if the command was found, and false if not. This is really the most portable way, since command -v, type, and which are not @@ -721,7 +721,7 @@ need of answering a wide bunch of questions before getting any little thing installed. -Keep usage notes to what they belong: the NEWS.Debian, or README.Debian file. +Keep usage notes to what they belong: the NEWS.Debian, or README.Debian file. Only use notes for important notes which may directly affect the package usability. Remember that notes will always block the install until confirmed or bother the user by email. @@ -747,7 +747,7 @@ 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 +Badly written templates give a poor image of your package, of your work... or even of Debian itself. @@ -768,7 +768,7 @@ translated by translation teams or even individuals. Please use gettext-based templates. Install po-debconf on your development system and read its -documentation (man po-debconf is a good start). +documentation (man po-debconf is a good start). Avoid changing templates too often. Changing templates text induces more work @@ -782,26 +782,26 @@ enough, the original translation is kept in PO files but marked as If you plan to do changes to your original templates, please use the notification system provided with the po-debconf package, namely the -podebconf-report-po, to contact translators. Most active +role="package">po-debconf package, namely the +podebconf-report-po, to contact translators. Most active translators are very responsive and getting their work included along with your modified templates will save you additional uploads. If you use gettext-based templates, the translator's name and e-mail addresses are mentioned in the PO -files headers and will be used by -podebconf-report-po. +files headers and will be used by +podebconf-report-po. A recommended use of that utility is: -cd debian/po && podebconf-report-po --languageteam --withtranslators --call --deadline="+10 days" +cd debian/po && podebconf-report-po --call --languageteam --withtranslators --deadline="+10 days" -This command will first synchronize the PO and POT files in debian/po with +This command will first synchronize the PO and POT files in debian/po with the templates files listed in debian/po/POTFILES.in. -Then, it will send a call for translation updates to the language team +Then, it will send a call for new translations, in the &email-debian-i18n; mailing +list. Finally, it will also send a call for translation updates to the language team (mentioned in the Language-Team field of each PO file) as well as the last translator (mentioned in -Last-translator). Finally, it will also send a call for -new translations, in the &email-debian-i18n; mailing list. +Last-translator). Giving a deadline to translators is always appreciated, so that they can @@ -841,11 +841,10 @@ strings. -Try finding a complete translation file before +Try finding a complete translation file before the change: -for i in debian/po/*po; do echo -n $i: ; msgfmt -o /dev/null ---statistics $i; done +for i in debian/po/*po; do echo -n $i: ; msgfmt -o /dev/null --statistics $i; done The file only showing translated items will be used as the reference file. If there is none (which should not happen if you take @@ -873,7 +872,7 @@ change in punctuation, for instance. Modify all PO files by using sed. The use of that command is recommended over any text editor to guarantee that the files encoding will -not be broken by the edit action. +not be broken by the edit action: cd debian/po @@ -887,7 +886,7 @@ Change the debconf template file to fix the typo. -Run debconf-updatepo +Run debconf-updatepo. @@ -900,8 +899,10 @@ msgfmt -o /dev/null --statistics debian/po/foo.po + If the file's statistics changed, you did something wrong. Try again or ask for help on the &email-debian-i18n; mailing list. + @@ -914,43 +915,42 @@ Put all incomplete PO files out of the way. You can check the completeness by using (needs the gettext package installed): -for i in debian/po/*po; do echo -n $i: ; msgfmt -o /dev/null ---statistics $i; done +for i in debian/po/*po; do echo -n $i: ; msgfmt -o /dev/null --statistics $i; done -move all files which report either fuzzy strings to a temporary place. Files +Move all files which report either fuzzy strings to a temporary place. Files which report no fuzzy strings (only translated and untranslated) will be kept in place. -now and now only, modify the template for +Now and now only, modify the template for the typos and check again that translation are not impacted (typos, spelling -errors, sometimes typographical corrections are usually OK) +errors, sometimes typographical corrections are usually OK). -run debconf-updatepo. This will fuzzy all strings you -modified in translations. You can see this by running the above again +Run debconf-updatepo. This will fuzzy all strings you +modified in translations. You can see this by running the above again. -use the following command: +Use the following command: for i in debian/po/*po; do msgattrib --output-file=$i --clear-fuzzy $i; done -move back to debian/po the files which showed fuzzy strings in the first step +Move back to debian/po the files which showed fuzzy strings in the first step. -run debconf-updatepo again +Run debconf-updatepo again. @@ -1007,14 +1007,14 @@ This part gives some information which is mostly taken from the
Type
-string: +string Results in a free-form input field that the user can type any string into.
-password: +password Prompts the user for a password. Use this with caution; be aware that the password the user enters will be written to debconf's database. You should @@ -1023,7 +1023,7 @@ probably clean that value out of the database as soon as is possible.
-boolean: +boolean A true/false choice. Remember: true/false, not yes/no... @@ -1031,7 +1031,7 @@ yes/no...
-select: +select A choice between one of a number of values. The choices must be specified in a field named 'Choices'. Separate the possible values with commas and spaces, @@ -1069,7 +1069,7 @@ The debconf templates flag system offers many such possibilities. The
-multiselect: +multiselect Like the select data type, except the user can choose any number of items from the choices list (or chose none of them). @@ -1077,7 +1077,7 @@ the choices list (or chose none of them).
-note: +note Rather than being a question per se, this datatype indicates a note that can be displayed to the user. It should be used only for important notes that the @@ -1088,14 +1088,14 @@ note to them in some cases.
-text: +text This type is now considered obsolete: don't use it.
-error: +error This type is designed to handle error messages. It is mostly similar to the note type. Frontends may present it differently (for instance, the dialog @@ -1162,7 +1162,7 @@ read below.
Choices -This field should be used for Select and Multiselect types. It contains the +This field should be used for select and multiselect types. It contains the possible choices which will be presented to users. These choices should be separated by commas. @@ -1263,7 +1263,7 @@ the interface often makes this clear). -The short description should be considered to be a *title*. +The short description should be considered to be a title. @@ -1276,10 +1276,10 @@ explanation of the note. Phrases, no terse writing style. Do not abuse debconf. Notes are the most common way to abuse debconf. As written in debconf-devel manual page: it's -best to use them only for warning about very serious problems. The NEWS.Debian -or README.Debian files are the appropriate location for a lot of notes. If, by +best to use them only for warning about very serious problems. The NEWS.Debian +or README.Debian files are the appropriate location for a lot of notes. If, by reading this, you consider converting your Note type templates to entries in -NEWS/Debian or README.Debian, plus consider keeping existing translations for +NEWS.Debian or README.Debian, plus consider keeping existing translations for the future. @@ -1302,7 +1302,7 @@ considerably help translators for doing their work. If the default value, for a select template, is likely to vary depending on the user language (for instance, if the choice is a language choice), please use -the _DefaultChoice trick. +the _Default trick. This special field allow translators to put the most appropriate choice @@ -1319,9 +1319,9 @@ Type: select __Choices: Afrikaans (af), Bulgarian (bg), Catalan (ca), Chinese (zh), Czech (cs), Danish (da), Dutch (nl), English (en), Esperanto (eo), Estonian (et), Finnish (fi), French (fr), German (de), Hebrew (he), Icelandic (is), Italian (it), Latvian (lv), Norwegian (no), Polish (pl), Portuguese (pt), Romanian (ro), Russian (ru), Spanish (es), Swedish (sv) # This is the default choice. Translators may put their own language here # instead of the default. -# WARNING : you MUST use the ENGLISH FORM of your language +# WARNING : you MUST use the ENGLISH NAME of your language # For instance, the french translator will need to put French (fr) here. -_DefaultChoice: English (en)[ translators, please see comment in PO files] +_Default: English[ translators, please see comment in PO files] _Description: Geneweb default language: @@ -1330,7 +1330,7 @@ note the use of comments which will show up in files the translators will work with. -The comments are needed as the DefaultChoice trick is a bit confusing: the +The comments are needed as the _Default trick is a bit confusing: the translators may put their own choice
@@ -1343,12 +1343,12 @@ not use Default at all. If you use po-debconf (and you should, see -2.2), consider making this field translatable, if you think it may be +), consider making this field translatable, if you think it may be translated. If the default value may vary depending on language/country (for instance the -default value for a language choice), consider using the special _DefaultChoice +default value for a language choice), consider using the special _Default type documented in po-debconf 7 ). @@ -1380,7 +1380,7 @@ easier both for maintainer and translators; transition scripts are provided. Using po-debconf, the translation is -stored in po files (drawing from +stored in .po files (drawing from gettext translation techniques). Special template files contain the original messages and mark which fields are translatable. When you change the value of a translatable field, by calling @@ -1402,18 +1402,18 @@ There's no way to eliminate all that work, but you can make things easier for translators. -If you maintain documentation of any size, its easier for translators if they +If you maintain documentation of any size, it is easier for translators if they have access to a source control system. That lets translators see the 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 +debian-installer 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. +You might wish to adapt and provide that in your VCS area. If you maintain XML or SGML documentation, we suggest that you isolate any @@ -1501,8 +1501,8 @@ upstream. The manpages do not need to be written directly in the troff format. Popular source formats are Docbook, POD and reST, which can be converted using xsltproc, pod2man and -rst2man respectively. To a lesser extent, the -help2manprogram can also be used to write a stub. +rst2man respectively. To a lesser extent, the +help2man program can also be used to write a stub.
@@ -1599,13 +1599,13 @@ to keep it all in a single package. However, if the size of the data is considerable, consider splitting it out -into a separate, architecture-independent package (_all.deb). By doing this, +into a separate, architecture-independent package (_all.deb). By doing this, you avoid needless duplication of the same data into eleven or more .debs, one per each architecture. While this adds some extra overhead into the Packages files, it saves a lot of disk space on Debian mirrors. Separating out architecture-independent data also reduces processing time of lintian (see ) when run over the entire Debian archive. +linkend="tools-lint"/>) when run over the entire Debian archive.
@@ -1658,7 +1658,7 @@ your short description. If you are looking for examples, just run:
-Best practices for <filename>orig.tar.gz</filename> files +Best practices for <filename>.orig.tar.{gz,bz2,lzma}</filename> files There are two kinds of original source tarballs: Pristine source and repackaged upstream source. @@ -1667,8 +1667,8 @@ upstream source. Pristine source The defining characteristic of a pristine source tarball is that the -.orig.tar.{gz,bz2} file is byte-for-byte identical to a tarball officially -distributed by the upstream author. We cannot prevent +.orig.tar.{gz,bz2,lzma} file is byte-for-byte identical to a tarball officially +distributed by the upstream author. We cannot prevent upstream authors from changing the tarball they distribute without also incrementing the version number, so there can be no guarantee that a pristine tarball is identical to what upstream currently @@ -1677,7 +1677,7 @@ identical to something that upstream once did distribute. If a difference arises later (say, if upstream notices that he wasn't using maximal compression in his original distribution and then re-gzips it), that's just too bad. Since there is no good -way to upload a new .orig.tar.{gz,bz2} for the same version, there is not even any +way to upload a new .orig.tar.{gz,bz2,lzma} for the same version, there is not even any point in treating this situation as a bug. This makes it possible to use checksums to easily verify that all changes between Debian's version and upstream's are contained in the Debian diff. Also, if the original @@ -1697,14 +1697,14 @@ tarballs as pristine source. Its strategy is equivalent to the following: It unpacks the tarball in an empty temporary directory by doing -zcat path/to/<packagename>_<upstream-version>.orig.tar.gz | tar xf - +zcat path/to/packagename_upstream-version.orig.tar.gz | tar xf - If, after this, the temporary directory contains nothing but one directory and no other files, dpkg-source renames that directory to -<packagename>-<upstream-version>(.orig). The +packagename-upstream-version(.orig). The name of the top-level directory in the tarball does not matter, and is forgotten. @@ -1715,7 +1715,7 @@ Otherwise, the upstream tarball must have been packaged without a common top-level directory (shame on the upstream author!). In this case, dpkg-source renames the temporary directory itself to -<packagename>-<upstream-version>(.orig). +packagename-upstream-version(.orig). @@ -1731,17 +1731,17 @@ gzipped tar at all, or if upstream's tarball contains non-DFSG-free material that you must remove before uploading. -In these cases the developer must construct a suitable .orig.tar.{gz,bz2} - file himself. We refer to such a tarball as a repackaged upstream +In these cases the developer must construct a suitable .orig.tar.{gz,bz2,lzma} +file himself. We refer to such a tarball as a repackaged upstream source. Note that a repackaged upstream source is different from a Debian-native package. A repackaged source still comes with Debian-specific -changes in a separate .diff.gz or .debian.tar.{gz,bz2} and still has a version -number composed of <upstream-version> and -<debian-revision>. +changes in a separate .diff.gz or .debian.tar.{gz,bz2,lzma} +and still has a version number composed of upstream-version and +debian-version. There may be cases where it is desirable to repackage the source even though -upstream distributes a .tar.gz that could in principle be +upstream distributes a .tar.{gz,bz2,lzma} that could in principle be used in its pristine form. The most obvious is if significant space savings can be achieved by recompressing the tar archive or by removing genuinely useless cruft from the upstream @@ -1749,12 +1749,12 @@ archive. Use your own discretion here, but be prepared to defend your decision if you repackage source that could have been pristine. -A repackaged .orig.tar.{gz,bz2} +A repackaged .orig.tar.{gz,bz2,lzma} -should be documented in the resulting source package. +should be documented in the resulting source package. Detailed information on how the repackaged source was obtained, and on how this can be reproduced should be provided in debian/copyright. It is also a good idea to provide a @@ -1762,19 +1762,19 @@ and on how this can be reproduced should be provided in debian/rules file that repeats the process, as described in the Policy Manual, Main -building script: debian/rules. +building script: debian/rules. should not contain any file that does not -come from the upstream author(s), or whose contents has been changed by you. - As a special exception, if the omission of non-free files +come from the upstream author(s), or whose contents has been changed by +you. As a special exception, if the omission of non-free files would lead to the source failing to build without assistance from the Debian diff, it might be appropriate to instead edit the files, omitting only the -non-free parts of them, and/or explain the situation in a README.source +non-free parts of them, and/or explain the situation in a README.source file in the root of the source tree. But in that case please also urge the -upstream author to make the non-free components easier seperable from the rest +upstream author to make the non-free components easier separable from the rest of the source. @@ -1784,7 +1784,7 @@ of the source. reasons, preserve the entire building and portablility infrastructure provided by the upstream author. For example, it is not a sufficient reason for omitting a file that it is used only when building on MS-DOS. Similarly, a -Makefile provided by upstream should not be omitted even if the first thing +Makefile provided by upstream should not be omitted even if the first thing your debian/rules does is to overwrite it by running a configure script. @@ -1797,7 +1797,7 @@ mirror rather than trying to locate a canonical upstream distribution point). should use -<packagename>-<upstream-version>.orig as the +packagename-upstream-version.orig as the name of the top-level directory in its tarball. This makes it possible to distinguish pristine tarballs from repackaged ones. @@ -1831,9 +1831,9 @@ it in its official location). Best practices for debug packages A debug package is a package with a name ending in -dbg, that contains -additional information that gdb can use. Since Debian binaries are stripped by +additional information that gdb can use. Since Debian binaries are stripped by default, debugging information, including function names and line numbers, is -otherwise not available when running gdb on Debian binaries. Debug packages +otherwise not available when running gdb on Debian binaries. Debug packages allow users who need this additional debugging information to install it, without bloating a regular system with the information. @@ -1850,7 +1850,7 @@ candidates for debug packages. Some debug packages may contain an entire special debugging build of a library or other binary, but most of them can save space and build time by instead -containing separated debugging symbols that gdb can find and load on the fly +containing separated debugging symbols that gdb can find and load on the fly when debugging a program or library. The convention in Debian is to keep these symbols in /usr/lib/debug/path, where path is the path to the executable or library. For @@ -1860,17 +1860,17 @@ example, debugging symbols for /usr/bin/foo go in /usr/lib/debug/usr/lib/libfoo.so.1. -The debugging symbols can be extracted from an object file using -objcopy --only-keep-debug. Then the object file can be stripped, +The debugging symbols can be extracted from an object file using +objcopy --only-keep-debug. Then the object file can be stripped, and objcopy --add-gnu-debuglink used to specify the path to the debugging symbol file. objcopy 1 explains in detail how this works. -The dh_strip command in debhelper supports creating debug +The dh_strip command in debhelper supports creating debug packages, and can take care of using objcopy to separate -out the debugging symbols for you. If your package uses debhelper, all you +out the debugging symbols for you. If your package uses debhelper, all you need to do is call dh_strip --dbg-package=libfoo-dbg, and add an entry to debian/control for the debug package. diff --git a/common.ent b/common.ent index 3efbc1f..d041c82 100644 --- a/common.ent +++ b/common.ent @@ -104,7 +104,8 @@ - + + diff --git a/new-maintainer.dbk b/new-maintainer.dbk index 5ff7ccc..cc23449 100644 --- a/new-maintainer.dbk +++ b/new-maintainer.dbk @@ -156,7 +156,7 @@ url="&url-rfc2440;">RFC 2440. You need a version 4 key for use in Debian Development. Your key length must be at least 1024 bits; there is no reason to use a smaller key, and doing so -would be much less secure. Version 4 keys are keys conforming +would be much less secure. Version 4 keys are keys conforming to the OpenPGP standard as defined in RFC 2440. Version 4 is the key type that has always been created when using GnuPG. PGP versions since 5.x also could create v4 keys, the other choice having beein pgp 2.6.x compatible v3 keys diff --git a/pkgs.dbk b/pkgs.dbk index 759bb48..86d9273 100644 --- a/pkgs.dbk +++ b/pkgs.dbk @@ -135,7 +135,7 @@ It is conventional that the changelog entry of a package that contains a new upstream version of the software looks like this: - * new upstream version + * New upstream release. There are tools to help you create entries and finalize the @@ -230,12 +230,12 @@ accompanied by another file that contains the changes made by Debian For the native packages, the source package includes a Debian source control -file (.dsc) and the source tarball -(.tar.{gz,bz2,lzma}). A source package of a non-native package +file (.dsc) and the source tarball +(.tar.{gz,bz2,lzma}). A source package of a non-native package includes a Debian source control file, the original source tarball -(.orig.tar.{gz,bz2,lzma}) and the Debian changes -(.diff.gz for the source format “1.0” or -.debian.tar.{gz,bz2,lzma} for the source format “3.0 (quilt)”). +(.orig.tar.{gz,bz2,lzma}) and the Debian changes +(.diff.gz for the source format “1.0” or +.debian.tar.{gz,bz2,lzma} for the source format “3.0 (quilt)”). With source format “1.0”, whether a package is native or not was determined @@ -268,7 +268,7 @@ the archive. Please notice that, in non-native packages, permissions on files that are not -present in the .orig.tar.{gz,bz2,lzma} will not be preserved, as diff does not store file +present in the *.orig.tar.{gz,bz2,lzma} will not be preserved, as diff does not store file permissions in the patch. However when using source format “3.0 (quilt)”, permissions of files inside the debian directory are preserved since they are stored in a tar archive. @@ -962,7 +962,7 @@ be sure to mention this fact. Please note that if secrecy is needed you may not upload a fix to unstable (or -anywhere else, such as a public CVS repository). It is not sufficient to +anywhere else, such as a public VCS repository). It is not sufficient to obfuscate the details of the change, as the code itself is public, and can (and will) be examined by the general public. @@ -1278,8 +1278,8 @@ short summary of the reason for the removal request. [architecture list] is optional and only needed if the removal request only applies to some architectures, not all. Note that the reportbug will create a title conforming -to these rules when you use it to report a bug against the -ftp.debian.org pseudo-package. +to these rules when you use it to report a bug against the +ftp.debian.org pseudo-package. @@ -1292,13 +1292,13 @@ pending removal requests. -Note that removals can only be done for the unstable -, experimental and stable - distribution. Packages are not removed from +Note that removals can only be done for the unstable, +experimental and stable +distribution. Packages are not removed from testing directly. Rather, they will be removed automatically after the package has been removed from -unstable and no package in testing - depends on it. +unstable and no package in +testing depends on it. There is one exception when an explicit removal request is not necessary: If a @@ -1337,7 +1337,7 @@ 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, +Other useful programs include apt-cache rdepends, apt-rdepends, build-rdeps (in the devscripts package) and grep-dctrl. Removal of @@ -1379,13 +1379,13 @@ rename their software (or you made a mistake naming your package), you should follow a two-step process to rename it. In the first step, change the debian/control file to reflect the new name and to replace, provide and conflict with the -obsolete package name (see the -Debian Policy Manual for details). Please note that you +obsolete package name (see the Debian +Policy Manual for details). Please note that you should only add a Provides relation if all packages depending on the obsolete package name continue to work after the renaming. Once you've uploaded the package and the package -has moved into the archive, file a bug against -ftp.debian.org asking to remove the package with the +has moved into the archive, file a bug against ftp.debian.org +asking to remove the package with the obsolete name (see ). Do not forget to properly reassign the package's bugs at the same time. @@ -1464,7 +1464,7 @@ more information). If you take over an old package, you probably want to be listed as the package's official maintainer in the bug system. This will happen automatically once you upload a new version with an updated -Maintainer: field, although it can take a few hours after +Maintainer field, although it can take a few hours after the upload is done. If you do not expect to upload a new version for a while, you can use to get the bug reports. However, make sure that the old maintainer has no problem with the fact that @@ -1487,8 +1487,8 @@ Porting is the act of building Debian packages for architectures that are different from the original architecture of the package maintainer's binary package. It is a unique and essential activity. In fact, porters do most of the actual compiling of Debian packages. For instance, when a maintainer -uploads a (portable) source packages with binaries for the i386 - architecture, it will be built for each of the other architectures, +uploads a (portable) source packages with binaries for the i386 +architecture, it will be built for each of the other architectures, amounting to &number-of-arches; more builds.
@@ -1592,7 +1592,7 @@ standardize on different compilers. -Make sure your debian/rules contains separate binary-arch +Make sure your debian/rules contains separate binary-arch and binary-indep targets, as the Debian Policy Manual requires. Make sure that both targets work independently, that is, that you can call the target without having called the other before. To test this, @@ -1623,8 +1623,8 @@ The way to invoke dpkg-buildpackage is as -mporter-email. Of course, set porter-email to your email address. This will do a binary-only build of only the architecture-dependent portions of the package, -using the binary-arch target in debian/rules -. +using the binary-arch target in +debian/rules. If you are working on a Debian machine for your porting efforts and you need to @@ -1648,8 +1648,7 @@ version number greater than the currently available one). You have to make sure that your binary-only NMU doesn't render the package uninstallable. This could happen when a source package generates arch-dependent and arch-independent packages that have inter-dependencies -generated using dpkg's substitution variable $(Source-Version) -. +generated using dpkg's substitution variable $(Source-Version). Despite the required modification of the changelog, these are called @@ -1665,14 +1664,14 @@ source code). The ``magic'' for a recompilation-only NMU is triggered by using a suffix -appended to the package version number, following the form -bnumber. +appended to the package version number, following the form +bnumber. For instance, if the latest version you are recompiling against was version 2.9-3, your binary-only NMU should carry a version of -2.9-3+b1. If the latest version was 3.4+b1 - (i.e, a native package with a previous recompilation NMU), your -binary-only NMU should have a version number of 3.4+b2. - In the past, such NMUs used the third-level number on the +2.9-3+b1. If the latest version was 3.4+b1 +(i.e, a native package with a previous recompilation NMU), your +binary-only NMU should have a version number of 3.4+b2. +In the past, such NMUs used the third-level number on the Debian part of the revision to denote their recompilation-only status; however, this syntax was ambiguous with native packages and did not allow proper ordering of recompile-only NMUs, source NMUs, and security NMUs on @@ -1690,7 +1689,7 @@ to only build the architecture-dependent parts of the package. When to do a source NMU if you are a porter Porters doing a source NMU generally follow the guidelines found in , just like non-porters. However, it is expected that the wait +linkend="nmu"/>, just like non-porters. However, it is expected that the wait cycle for a porter's source NMU is smaller than for a non-porter, since porters have to cope with a large quantity of packages. Again, the situation varies depending on the distribution they are uploading to. It also varies whether @@ -1706,7 +1705,7 @@ on the unstable distribution. This period can be shortened if the problem is critical and imposes hardship on the porting effort, at the discretion of the porter group. (Remember, none of this is Policy, just mutually agreed upon guidelines.) For uploads to stable or -testing , please coordinate with the appropriate release +testing, please coordinate with the appropriate release team first. @@ -1769,9 +1768,9 @@ linkend="tools-porting"/>. The wanna-build system is used as a distributed, client-server build distribution system. It is usually used in -conjunction with build daemons running the buildd - program. Build daemons are ``slave'' hosts -which contact the central wanna-build +conjunction with build daemons running the buildd +program. Build daemons are ``slave'' hosts +which contact the central wanna-build system to receive a list of packages that need to be built. @@ -1784,8 +1783,8 @@ version is not the same as the one used on build daemons, but it is close enough to reproduce problems. -Most of the data produced by wanna-build - which is generally useful to porters is available on the +Most of the data produced by wanna-build +which is generally useful to porters is available on the web at . This data includes nightly updated statistics, queueing information and logs for build attempts. @@ -1845,7 +1844,7 @@ fail also, and indicate this to a human reader without actually trying. In order to prevent autobuilders from needlessly trying to build your package, -it must be included in packages-arch-specific, a list used +it must be included in Packages-arch-specific, a list used by the wanna-build script. The current version is available as ; please see the top of the file for whom to contact for changes. @@ -1854,12 +1853,12 @@ please see the top of the file for whom to contact for changes. Please note that it is insufficient to only add your package to -Packages-arch-specific without making it fail to build on unsupported +Packages-arch-specific without making it fail to build on unsupported 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.
@@ -1928,7 +1927,7 @@ is given an opportunity to upload a fix on their own. When doing an NMU, you must first make sure that your intention to NMU is clear. Then, you must send a patch with the differences between the current package and your proposed NMU to the BTS. The -nmudiff script in the devscripts package +nmudiff script in the devscripts package might be helpful. @@ -1937,7 +1936,7 @@ practices that the maintainer might be using. Taking them into account reduces the burden of getting your changes integrated back in the normal package workflow and thus increases the possibilities that that will happen. A good place where to look for for possible package-specific practices is -debian/README.source. +debian/README.source. Unless you have an excellent reason not to do so, you must then give some time @@ -1995,10 +1994,10 @@ defend the wisdom of any NMU you perform on its own merits.
-NMUs and debian/changelog +NMUs and <filename>debian/changelog</filename> Just like any other (source) upload, NMUs must add an entry to -debian/changelog, telling what has changed with this +debian/changelog, telling what has changed with this upload. The first line of this entry must explicitely mention that this upload is an NMU, e.g.: @@ -2009,7 +2008,7 @@ upload. The first line of this entry must explicitely mention that this upload The way to version NMUs differs for native and non-native packages. -If the package is a native package (without a debian revision in the version number), +If the package is a native package (without a Debian revision in the version number), the version must be the version of the last maintainer upload, plus +nmuX, where X is a counter starting at 1. @@ -2020,11 +2019,11 @@ version 1.5+nmu1. If the package is a not a native package, you should add a minor version number -to the debian revision part of the version number (the portion after the last -hyphen). This extra number must start at 1. For example, +to the Debian revision part of the version number (the portion after the last +hyphen). This extra number must start at 1. For example, if the current version is 1.5-2, then an NMU would get version 1.5-2.1. If a new upstream version -is packaged in the NMU, the debian revision is set to 0, for +is packaged in the NMU, the Debian revision is set to 0, for example 1.6-0.1. @@ -2054,14 +2053,14 @@ should be used, where X and When the release number is not yet known (often the case for testing, at the beginning of release cycles), the lowest release number higher than the last stable release number must be used. For -example, while Etch (Debian 4.0) is stable, a security NMU to stable for a +example, while Lenny (Debian 5.0) is stable, a security NMU to stable for a package at version 1.5-3 would have version -1.5-3+deb40u1, whereas a security NMU to Lenny would get -version 1.5-3+deb50u1. After the release of Lenny, security +1.5-3+deb50u1, whereas a security NMU to Squeeze would get +version 1.5-3+deb60u1. After the release of Squeeze, security uploads to the testing distribution will be versioned -+deb51uZ, until it is known whether that release will be -Debian 5.1 or Debian 6.0 (if that becomes the case, uploads will be versioned -as +deb60uZ. ++deb61uZ, until it is known whether that release will be +Debian 6.1 or Debian 7.0 (if that becomes the case, uploads will be versioned +as +deb70uZ).
@@ -2138,7 +2137,7 @@ package is used. BinNMUs are usually triggered on the buildds by wanna-build. -An entry is added to debian/changelog, +An entry is added to debian/changelog, explaining why the upload was needed and increasing the version number as described in . This entry should not be included in the next upload. @@ -2147,7 +2146,7 @@ This entry should not be included in the next upload. Buildds upload packages for their architecture to the archive as binary-only uploads. Strictly speaking, these are binNMUs. However, they are not normally -called NMU, and they don't add an entry to debian/changelog. +called NMU, and they don't add an entry to debian/changelog. @@ -2165,8 +2164,8 @@ uploads are uploads of orphaned packages. QA uploads are very much like normal maintainer uploads: they may fix anything, even minor issues; the version numbering is normal, and there is no need to use -a delayed upload. The difference is that you are not listed as the Maintainer -or Uploader for the package. Also, the changelog entry of a QA upload has a +a delayed upload. The difference is that you are not listed as the Maintainer +or Uploader for the package. Also, the changelog entry of a QA upload has a special first line: @@ -2199,14 +2198,18 @@ the new version (see ). Sometimes you are fixing and/or updating a package because you are member of a -packaging team (which uses a mailing list as Maintainer or Uploader, see ) but you don't want to add yourself to Uploaders +packaging team (which uses a mailing list as Maintainer or Uploader, see ) but you don't want to add yourself to Uploaders because you do not plan to contribute regularly to this specific package. If it conforms with your team's policy, you can perform a normal upload without -being listed directly as Maintainer or Uploader. In that case, you should -start your changelog entry with the following line: * Team upload.. +being listed directly as Maintainer or Uploader. In that case, you should +start your changelog entry with the following line: + + * Team upload. + + @@ -2218,7 +2221,7 @@ Collaborative maintenance is a term describing the sharing of Debian package maintenance duties by several people. This collaboration is almost always a good idea, since it generally results in higher quality and faster bug fix turnaround times. It is strongly recommended that packages with a priority of -Standard or which are part of the base set have +standard or which are part of the base set have co-maintainers. @@ -2238,7 +2241,7 @@ easy: Setup the co-maintainer with access to the sources you build the package from. Generally this implies you are using a network-capable version control system, -such as CVS or Subversion. Alioth (see +such as CVS or Subversion. Alioth (see ) provides such tools, amongst others. @@ -2262,21 +2265,21 @@ should subscribe themselves to the appropriate source package. Another form of collaborative maintenance is team maintenance, which is recommended if you maintain several packages with the same group of developers. -In that case, the Maintainer and Uploaders field of each package must be +In that case, the Maintainer and Uploaders field of each package must be managed with care. It is recommended to choose between one of the two following schemes: -Put the team member mainly responsible for the package in the Maintainer field. -In the Uploaders, put the mailing list address, and the team members who care +Put the team member mainly responsible for the package in the Maintainer field. +In the Uploaders, put the mailing list address, and the team members who care for the package. -Put the mailing list address in the Maintainer field. In the Uploaders field, +Put the mailing list address in the Maintainer field. In the Uploaders field, put the team members who care for the package. In this case, you must make sure the mailing list accept bug reports without any human interaction (like moderation for non-subscribers). @@ -2286,14 +2289,14 @@ moderation for non-subscribers). In any case, it is a bad idea to automatically put all team members in the -Uploaders field. It clutters the Developer's Package Overview listing (see +Uploaders field. It clutters the Developer's Package Overview listing (see ) with packages one doesn't really care for, and creates a false sense of good maintenance. For the same reason, team members do -not need to add themselves to the Uploaders field just because they are +not need to add themselves to the Uploaders field just because they are uploading the package once, they can do a “Team upload” (see ). Conversely, it it a bad idea to keep a -package with only the mailing list address as a Maintainer and no -Uploaders. +package with only the mailing list address as a Maintainer and no +Uploaders. @@ -2309,8 +2312,8 @@ after they have undergone some degree of testing in They must be in sync on all architectures and mustn't have dependencies that make them uninstallable; they also have to have generally no known -release-critical bugs at the time they're installed into testing -. This way, testing should always be close to +release-critical bugs at the time they're installed into testing. +This way, testing should always be close to being a release candidate. Please see below for details. @@ -2350,7 +2353,7 @@ available in unstable, but not affecting the version in It must be available on all architectures on which it has previously been built -in unstable. may be of interest +in unstable. dak ls may be of interest to check that information; @@ -2365,7 +2368,7 @@ It must not break any dependency of a package which is already available in The packages on which it depends must either be available in testing or they must be accepted into testing at the same time (and they will be if they fulfill -all the necessary criteria); +all the necessary criteria). @@ -2398,7 +2401,7 @@ url="http://release.debian.org/migration/"> — but be warned, this page shows build dependencies which are not considered by britney.
-out-of-date +Out-of-date For the testing migration script, outdated means: There are @@ -2435,10 +2438,10 @@ Consider this example: -The package is out of date on alpha in unstable, and will +The package is out of date on alpha in unstable, and will not go to testing. Removing the package would not help at all, the package is still out of date on alpha, and will not -propagate to testing. +propagate to testing. However, if ftp-master removes a package in unstable (here @@ -2492,8 +2495,8 @@ with the new version of b; then a may be removed to allow b in. -Of course, there is another reason to remove a package from testing -: It's just too buggy (and having a single RC-bug is enough to be +Of course, there is another reason to remove a package from testing: +It's just too buggy (and having a single RC-bug is enough to be in this state). @@ -2504,7 +2507,7 @@ will automatically be removed.
-circular dependencies +Circular dependencies A situation which is not handled very well by britney is if package a depends on the new version of package @@ -2548,28 +2551,28 @@ happens to one of your packages.
-influence of package in testing +Influence of package in testing -Generally, there is nothing that the status of a package in testing - means for transition of the next version from unstable - to testing, with two exceptions: +Generally, there is nothing that the status of a package in testing +means for transition of the next version from unstable +to testing, with two exceptions: If the RC-bugginess of the package goes down, it may go in even if it is still -RC-buggy. The second exception is if the version of the package in -testing is out of sync on the different arches: Then any arch might +RC-buggy. The second exception is if the version of the package in +testing is out of sync on the different arches: Then any arch might just upgrade to the version of the source package; however, this can happen only if the package was previously forced through, the arch is in fuckedarches, -or there was no binary package of that arch present in unstable - at all during the testing migration. +or there was no binary package of that arch present in unstable +at all during the testing migration. -In summary this means: The only influence that a package being in -testing has on a new version of the same package is that the new +In summary this means: The only influence that a package being in +testing has on a new version of the same package is that the new version might go in easier.
-details +Details If you are interested in details, this is how britney works: @@ -2583,8 +2586,8 @@ part of britney.) (There is a similar thing for binary-only updates, but this is not described here. If you're interested in that, please peruse the code.) -Now, the more complex part happens: Britney tries to update testing - with the valid candidates. For that, britney tries to add each +Now, the more complex part happens: Britney tries to update testing +with the valid candidates. For that, britney tries to add each valid candidate to the testing distribution. If the number of uninstallable packages in testing doesn't increase, the package is accepted. From that point on, the accepted package is considered to be part @@ -2597,7 +2600,7 @@ If you want to see more details, you can look it up on merkel:/org/&ftp-debian-org;/testing/update_out/ (or in merkel:~aba/testing/update_out to see a setup with a smaller packages file). Via web, it's at +url="http://&ftp-master-host;/testing/update_out_code/">. The hints are available via . The testing distribution is fed with packages from unstable according to the rules explained above. However, -in some cases, it is necessary to upload packages built only for -testing. For that, you may want to upload to -testing-proposed-updates. +in some cases, it is necessary to upload packages built only for +testing. For that, you may want to upload to +testing-proposed-updates. Keep in mind that packages uploaded there are not automatically processed, they @@ -2626,8 +2629,8 @@ give on &email-debian-devel-announce;. You should not upload to testing-proposed-updates when you can update your packages through unstable. If you can't -(for example because you have a newer development version in unstable -), you may use this facility, but it is recommended that you ask for +(for example because you have a newer development version in unstable), +you may use this facility, but it is recommended that you ask for authorization from the release manager first. Even if a package is frozen, updates through unstable are possible, if the upload via unstable does not pull in any new dependencies. @@ -2635,7 +2638,7 @@ updates through unstable are possible, if the upload via Version numbers are usually selected by adding the codename of the testing distribution and a running number, like -1.2sarge1 for the first upload through +1.2squeeze1 for the first upload through testing-proposed-updates of package version 1.2. @@ -2646,8 +2649,8 @@ Please make sure you didn't miss any of these items in your upload: Make sure that your package really needs to go through -testing-proposed-updates, and can't go through -unstable; +testing-proposed-updates, and can't go through +unstable; @@ -2701,13 +2704,13 @@ currently, these are critical, grave and Such bugs are presumed to have an impact on the chances that the package will be released with the stable release of Debian: in general, if a package has open release-critical bugs filed on it, it won't get into -testing, and consequently won't be released in -stable. +testing, and consequently won't be released in +stable. The unstable bug count are all release-critical bugs which -are marked to apply to package/version - combinations that are available in unstable for a release +are marked to apply to package/version +combinations that are available in unstable for a release architecture. The testing bug count is defined analogously.
@@ -2719,9 +2722,9 @@ break other packages? The structure of the distribution archives is such that they can only contain one version of a package; a package is defined by its name. So when the source package acmefoo is installed into testing, -along with its binary packages acme-foo-bin, -acme-bar-bin, libacme-foo1 and -libacme-foo-dev, the old version is removed. +along with its binary packages acme-foo-bin, +acme-bar-bin, libacme-foo1 and +libacme-foo-dev, the old version is removed. However, the old version may have provided a binary package with an old soname diff --git a/resources.dbk b/resources.dbk index c83e8a9..c4ab2eb 100644 --- a/resources.dbk +++ b/resources.dbk @@ -1487,7 +1487,7 @@ item. Here are a few examples of valid mails used to generate news items in the PTS. -The first one adds a link to the cvsweb interface of debian-cd in the Static +The first one adds a link to the viewsvn interface of debian-cd in the Static information section: -- 2.30.2