X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?p=developers-reference.git;a=blobdiff_plain;f=best-pkging-practices.dbk;h=ca1bfb38ffe1ee40eb9538d01e66b17c364f11ab;hp=981c35fe9ae15f3fc8c01deac1b091b7c6fcb5f7;hb=6af79112dbb3da2664c2e5d4a17daed580b074b6;hpb=c81927355fe51c8a09827d098d0caad05a052d67 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: