X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ianmdlvl/git?a=blobdiff_plain;f=po4a%2Fpo%2Fbest-pkging-practices.pot;h=ffe7e72031d83a84976f88120c230930928ce032;hb=dd09147814be411e5c238732230be88cf2f54dd4;hp=a1c901e837e6eb22c386896721f65d54122b0626;hpb=bafa67a2c7b794d78396cf18f8d8e44d3160e3ac;p=developers-reference.git diff --git a/po4a/po/best-pkging-practices.pot b/po4a/po/best-pkging-practices.pot index a1c901e..ffe7e72 100644 --- a/po4a/po/best-pkging-practices.pot +++ b/po4a/po/best-pkging-practices.pot @@ -7,13 +7,14 @@ msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" -"POT-Creation-Date: 2010-05-06 17:34-0400\n" +"POT-Creation-Date: 2011-09-10 16:28-0400\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" +"Language: \n" "MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=utf-8\n" -"Content-Transfer-Encoding: ENCODING" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" #. type: Content of: #: best-pkging-practices.dbk:7 @@ -111,8 +112,8 @@ msgid "" "<manvolnum>1</manvolnum> </citerefentry>, and looking at the examples that " "come with the package. <command>dh_make</command>, from the <systemitem " "role=\"package\">dh-make</systemitem> package (see <xref " -"linkend=\"dh-make\"/> ), can be used to convert a vanilla source package to " -"a <systemitem role=\"package\">debhelper</systemitem>ized package. This " +"linkend=\"dh-make\"/>), can be used to convert a vanilla source package to a " +"<systemitem role=\"package\">debhelper</systemitem>ized package. This " "shortcut, though, should not convince you that you do not need to bother " "understanding the individual <command>dh_*</command> helpers. If you are " "going to use a helper, you do need to take the time to learn to use that " @@ -328,7 +329,7 @@ msgid "" "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 " +"initial indefinite or definite article — \"a\", \"an\", or \"the\". Thus for " "instance:" msgstr "" @@ -345,7 +346,8 @@ msgstr "" msgid "" "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:" +"package <replaceable>name</replaceable> and " +"<replaceable>synopsis</replaceable> into this formula:" msgstr "" #. type: Content of: <chapter><section><section><para> @@ -694,7 +696,7 @@ msgstr "" msgid "" "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 <xref linkend=\"upload-bugfix\"/> ." +"changelog is bad practice. See <xref linkend=\"upload-bugfix\"/>." msgstr "" #. type: Content of: <chapter><section><section><para> @@ -826,21 +828,22 @@ msgstr "" #. type: Content of: <chapter><section><section><title> #: best-pkging-practices.dbk:566 -msgid "Supplementing changelogs with NEWS.Debian files" +msgid "Supplementing changelogs with <filename>NEWS.Debian</filename> files" msgstr "" #. type: Content of: <chapter><section><section><para> #: best-pkging-practices.dbk:568 msgid "" -"Important news about changes in a package can also be put in <filename> " -"NEWS.Debian</filename> 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 <filename> NEWS.Debian</filename> " -"file after the install. And it's better than listing major changes in " -"<filename>README.Debian</filename>, since the user can easily miss such " -"notes." +"Important news about changes in a package can also be put in " +"<filename>NEWS.Debian</filename> files. The news will be displayed by tools " +"like <systemitem role=\"package\">apt-listchanges</systemitem>, 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 " +"<systemitem role=\"package\">debconf</systemitem> notes since it is less " +"annoying and the user can go back and refer to the " +"<filename>NEWS.Debian</filename> file after the install. And it's better " +"than listing major changes in <filename>README.Debian</filename>, since the " +"user can easily miss such notes." msgstr "" #. type: Content of: <chapter><section><section><para> @@ -851,8 +854,8 @@ msgid "" "rather than the more concise summaries that would go in a changelog. It's a " "good idea to run your file through <literal>dpkg-parsechangelog</literal> to " "check its formatting as it will not be automatically checked during build as " -"the changelog is. Here is an example of a real <filename>NEWS.Debian " -"</filename> file:" +"the changelog is. Here is an example of a real " +"<filename>NEWS.Debian</filename> file:" msgstr "" #. type: Content of: <chapter><section><section><screen> @@ -873,11 +876,12 @@ msgstr "" #. type: Content of: <chapter><section><section><para> #: best-pkging-practices.dbk:598 msgid "" -"The <filename>NEWS.Debian</filename> file is installed as <filename> " -"/usr/share/doc/<replaceable>package</replaceable>/NEWS.Debian.gz</filename>. " +"The <filename>NEWS.Debian</filename> file is installed as " +"<filename>/usr/share/doc/<replaceable>package</replaceable>/NEWS.Debian.gz</filename>. " "It is compressed, and always has that name even in Debian native packages. " -"If you use <literal>debhelper</literal>, <literal>dh_installchangelogs " -"</literal> will install <filename>debian/NEWS</filename> files for you." +"If you use <literal>debhelper</literal>, " +"<literal>dh_installchangelogs</literal> will install " +"<filename>debian/NEWS</filename> files for you." msgstr "" #. type: Content of: <chapter><section><section><para> @@ -973,7 +977,7 @@ msgstr "" #. type: Content of: <chapter><section><para> #: best-pkging-practices.dbk:676 msgid "" -"You can use this function to search <literal>$PATH</literal> for a command " +"You can use this function to search <varname>$PATH</varname> 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 " "<literal>command -v</literal>, <command>type</command>, and " @@ -1045,10 +1049,10 @@ msgstr "" #. type: Content of: <chapter><section><section><para> #: best-pkging-practices.dbk:724 msgid "" -"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." +"Keep usage notes to what they belong: the <filename>NEWS.Debian</filename>, " +"or <filename>README.Debian</filename> 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." msgstr "" #. type: Content of: <chapter><section><section><para> @@ -1087,8 +1091,8 @@ msgstr "" #. type: Content of: <chapter><section><section><section><para> #: best-pkging-practices.dbk:750 msgid "" -"Badly written templates give a poor image of your package, of your work...or " -"even of Debian itself." +"Badly written templates give a poor image of your package, of your " +"work... or even of Debian itself." msgstr "" #. type: Content of: <chapter><section><section><section><para> @@ -1118,7 +1122,7 @@ msgstr "" msgid "" "Please use gettext-based templates. Install <systemitem " "role=\"package\">po-debconf</systemitem> on your development system and read " -"its documentation (<literal>man po-debconf</literal> is a good start)." +"its documentation (<command>man po-debconf</command> is a good start)." msgstr "" #. type: Content of: <chapter><section><section><section><para> @@ -1137,13 +1141,13 @@ msgstr "" msgid "" "If you plan to do changes to your original templates, please use the " "notification system provided with the <systemitem " -"role=\"package\">po-debconf</systemitem> package, namely the <command> " -"podebconf-report-po</command>, to contact translators. Most active " +"role=\"package\">po-debconf</systemitem> package, namely the " +"<command>podebconf-report-po</command>, 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 <command> " -"podebconf-report-po</command>." +"mentioned in the PO files headers and will be used by " +"<command>podebconf-report-po</command>." msgstr "" #. type: Content of: <chapter><section><section><section><para> @@ -1155,20 +1159,20 @@ msgstr "" #: best-pkging-practices.dbk:796 #, no-wrap msgid "" -"cd debian/po && podebconf-report-po --languageteam --withtranslators " -"--call --deadline=\"+10 days\"" +"cd debian/po && podebconf-report-po --call --languageteam " +"--withtranslators --deadline=\"+10 days\"" msgstr "" #. type: Content of: <chapter><section><section><section><para> #: best-pkging-practices.dbk:798 msgid "" -"This command will first synchronize the PO and POT files in debian/po with " -"the templates files listed in <filename>debian/po/POTFILES.in</filename>. " -"Then, it will send a call for translation updates to the language team " -"(mentioned in the <literal>Language-Team</literal> field of each PO file) " -"as well as the last translator (mentioned in " -"<literal>Last-translator</literal>). Finally, it will also send a call for " -"new translations, in the &email-debian-i18n; mailing list." +"This command will first synchronize the PO and POT files in " +"<filename>debian/po</filename> with the templates files listed in " +"<filename>debian/po/POTFILES.in</filename>. 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 <literal>Language-Team</literal> field of each PO file) as well as the " +"last translator (mentioned in <literal>Last-translator</literal>)." msgstr "" #. type: Content of: <chapter><section><section><section><para> @@ -1226,20 +1230,20 @@ msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para> #: best-pkging-practices.dbk:844 msgid "" -"Try finding a complete translation file <emphasis role=\"strong\"> " -"before</emphasis> the change:" +"Try finding a complete translation file <emphasis " +"role=\"strong\">before</emphasis> the change:" msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><programlisting> -#: best-pkging-practices.dbk:847 best-pkging-practices.dbk:917 +#: best-pkging-practices.dbk:847 best-pkging-practices.dbk:918 #, no-wrap msgid "" -"for i in debian/po/*po; do echo -n $i: ; msgfmt -o /dev/null\n" -"--statistics $i; done" +"for i in debian/po/*po; do echo -n $i: ; msgfmt -o /dev/null --statistics " +"$i; done" msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para> -#: best-pkging-practices.dbk:850 +#: best-pkging-practices.dbk:849 msgid "" "The file only showing <emphasis>translated</emphasis> items will be used as " "the reference file. If there is none (which should not happen if you take " @@ -1248,7 +1252,7 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para> -#: best-pkging-practices.dbk:858 +#: best-pkging-practices.dbk:857 msgid "" "Identify the needed change. In this example, let's assume the change is " "about fixing a typo in the word <literal>typo</literal> which was " @@ -1257,7 +1261,7 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para> -#: best-pkging-practices.dbk:866 +#: best-pkging-practices.dbk:865 msgid "" "Check that this change is only applied to the place where you really intend " "to make it and <emphasis role=\"strong\">not</emphasis> in any other place " @@ -1266,15 +1270,15 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para> -#: best-pkging-practices.dbk:874 +#: best-pkging-practices.dbk:873 msgid "" "Modify all PO files by using <command>sed</command>. 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." +"will not be broken by the edit action:" msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><programlisting> -#: best-pkging-practices.dbk:879 +#: best-pkging-practices.dbk:878 #, no-wrap msgid "" "cd debian/po\n" @@ -1282,35 +1286,42 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para> -#: best-pkging-practices.dbk:885 +#: best-pkging-practices.dbk:884 msgid "Change the debconf template file to fix the typo." msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para> -#: best-pkging-practices.dbk:890 -msgid "Run <command>debconf-updatepo</command>" +#: best-pkging-practices.dbk:889 +msgid "Run <command>debconf-updatepo</command>." msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para> -#: best-pkging-practices.dbk:895 +#: best-pkging-practices.dbk:894 msgid "" "Check the <filename>foo.po</filename> reference file. Its statistics should " "not be changed:" msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><programlisting> -#: best-pkging-practices.dbk:899 +#: best-pkging-practices.dbk:898 #, no-wrap msgid "msgfmt -o /dev/null --statistics debian/po/foo.po\n" msgstr "" +#. type: Content of: <chapter><section><section><section><orderedlist><listitem><para> +#: best-pkging-practices.dbk:903 +msgid "" +"If the file's statistics changed, you did something wrong. Try again or ask " +"for help on the &email-debian-i18n; mailing list." +msgstr "" + #. type: Content of: <chapter><section><section><section><para> -#: best-pkging-practices.dbk:908 +#: best-pkging-practices.dbk:909 msgid "Gettext utilities method:" msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para> -#: best-pkging-practices.dbk:913 +#: best-pkging-practices.dbk:914 msgid "" "Put all incomplete PO files out of the way. You can check the completeness " "by using (needs the <systemitem role=\"package\">gettext</systemitem> " @@ -1320,7 +1331,7 @@ msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para> #: best-pkging-practices.dbk:922 msgid "" -"move all files which report either fuzzy strings to a temporary place. " +"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." msgstr "" @@ -1328,21 +1339,21 @@ msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para> #: best-pkging-practices.dbk:929 msgid "" -"now <emphasis role=\"strong\">and now only</emphasis>, modify the template " +"Now <emphasis role=\"strong\">and now only</emphasis>, modify the template " "for the typos and check again that translation are not impacted (typos, " -"spelling errors, sometimes typographical corrections are usually OK)" +"spelling errors, sometimes typographical corrections are usually OK)." msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para> #: best-pkging-practices.dbk:936 msgid "" -"run <command>debconf-updatepo</command>. This will fuzzy all strings you " -"modified in translations. You can see this by running the above again" +"Run <command>debconf-updatepo</command>. This will fuzzy all strings you " +"modified in translations. You can see this by running the above again." msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para> #: best-pkging-practices.dbk:942 -msgid "use the following command:" +msgid "Use the following command:" msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><programlisting> @@ -1354,13 +1365,13 @@ msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para> #: best-pkging-practices.dbk:948 msgid "" -"move back to debian/po the files which showed fuzzy strings in the first " -"step" +"Move back to <filename>debian/po</filename> the files which showed fuzzy " +"strings in the first step." msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para> #: best-pkging-practices.dbk:953 -msgid "run <command>debconf-updatepo</command> again" +msgid "Run <command>debconf-updatepo</command> again." msgstr "" #. type: Content of: <chapter><section><section><section><title> @@ -1443,7 +1454,7 @@ msgstr "" #. type: Content of: <chapter><section><section><section><section><title> #: best-pkging-practices.dbk:1010 -msgid "string:" +msgid "string" msgstr "" #. type: Content of: <chapter><section><section><section><section><para> @@ -1453,7 +1464,7 @@ msgstr "" #. type: Content of: <chapter><section><section><section><section><title> #: best-pkging-practices.dbk:1017 -msgid "password:" +msgid "password" msgstr "" #. type: Content of: <chapter><section><section><section><section><para> @@ -1466,7 +1477,7 @@ msgstr "" #. type: Content of: <chapter><section><section><section><section><title> #: best-pkging-practices.dbk:1026 -msgid "boolean:" +msgid "boolean" msgstr "" #. type: Content of: <chapter><section><section><section><section><para> @@ -1478,7 +1489,7 @@ msgstr "" #. type: Content of: <chapter><section><section><section><section><title> #: best-pkging-practices.dbk:1034 -msgid "select:" +msgid "select" msgstr "" #. type: Content of: <chapter><section><section><section><section><para> @@ -1536,7 +1547,7 @@ msgstr "" #. type: Content of: <chapter><section><section><section><section><title> #: best-pkging-practices.dbk:1072 -msgid "multiselect:" +msgid "multiselect" msgstr "" #. type: Content of: <chapter><section><section><section><section><para> @@ -1548,7 +1559,7 @@ msgstr "" #. type: Content of: <chapter><section><section><section><section><title> #: best-pkging-practices.dbk:1080 -msgid "note:" +msgid "note" msgstr "" #. type: Content of: <chapter><section><section><section><section><para> @@ -1563,7 +1574,7 @@ msgstr "" #. type: Content of: <chapter><section><section><section><section><title> #: best-pkging-practices.dbk:1091 -msgid "text:" +msgid "text" msgstr "" #. type: Content of: <chapter><section><section><section><section><para> @@ -1573,7 +1584,7 @@ msgstr "" #. type: Content of: <chapter><section><section><section><section><title> #: best-pkging-practices.dbk:1098 -msgid "error:" +msgid "error" msgstr "" #. type: Content of: <chapter><section><section><section><section><para> @@ -1607,7 +1618,7 @@ msgstr "" #: best-pkging-practices.dbk:1119 msgid "" "The short description should be kept short (50 characters or so) so that it " -"may be accomodated by most debconf interfaces. Keeping it short also helps " +"may be accommodated by most debconf interfaces. Keeping it short also helps " "translators, as usually translations tend to end up being longer than the " "original." msgstr "" @@ -1677,7 +1688,7 @@ msgstr "" #. type: Content of: <chapter><section><section><section><para> #: best-pkging-practices.dbk:1165 msgid "" -"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." msgstr "" @@ -1758,7 +1769,7 @@ msgid "" "The short description should be phrased in the form of a question which " "should be kept short and should generally end with a question mark. Terse " "writing style is permitted and even encouraged if the question is rather " -"long (remember that translations are often longer than original versions)" +"long (remember that translations are often longer than original versions)." msgstr "" #. type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para> @@ -1798,7 +1809,9 @@ msgstr "" #. type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para> #: best-pkging-practices.dbk:1266 -msgid "The short description should be considered to be a *title*." +msgid "" +"The short description should be considered to be a <emphasis " +"role=\"strong\">title</emphasis>." msgstr "" #. type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para> @@ -1814,10 +1827,11 @@ msgid "" "<emphasis role=\"strong\">Do not abuse debconf.</emphasis> 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 reading this, you consider converting your Note type " -"templates to entries in NEWS/Debian or README.Debian, plus consider keeping " -"existing translations for the future." +"<filename>NEWS.Debian</filename> or <filename>README.Debian</filename> files " +"are the appropriate location for a lot of notes. If, by reading this, you " +"consider converting your Note type templates to entries in " +"<filename>NEWS.Debian</filename> or <filename>README.Debian</filename>, plus " +"consider keeping existing translations for the future." msgstr "" #. type: Content of: <chapter><section><section><section><title> @@ -1843,7 +1857,7 @@ msgstr "" msgid "" "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." +"use the _Default trick." msgstr "" #. type: Content of: <chapter><section><section><section><para> @@ -1873,9 +1887,9 @@ msgid "" "(ro), Russian (ru), Spanish (es), Swedish (sv)\n" "# This is the default choice. Translators may put their own language here\n" "# instead of the default.\n" -"# WARNING : you MUST use the ENGLISH FORM of your language\n" +"# WARNING : you MUST use the ENGLISH NAME of your language\n" "# For instance, the french translator will need to put French (fr) here.\n" -"_DefaultChoice: English (en)[ translators, please see comment in PO files]\n" +"_Default: English[ translators, please see comment in PO files]\n" "_Description: Geneweb default language:\n" msgstr "" @@ -1890,7 +1904,7 @@ msgstr "" #. type: Content of: <chapter><section><section><section><para> #: best-pkging-practices.dbk:1333 msgid "" -"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" msgstr "" @@ -1905,8 +1919,8 @@ msgstr "" #: best-pkging-practices.dbk:1345 msgid "" "If you use po-debconf (and you <emphasis role=\"strong\">should</emphasis>, " -"see 2.2), consider making this field translatable, if you think it may be " -"translated." +"see <xref linkend=\"s6.5.2.2\"/>), consider making this field translatable, " +"if you think it may be translated." msgstr "" #. type: Content of: <chapter><section><section><section><para> @@ -1914,9 +1928,9 @@ msgstr "" msgid "" "If the default value may vary depending on language/country (for instance " "the default value for a language choice), consider using the special " -"_DefaultChoice type documented in <citerefentry> " +"_Default type documented in <citerefentry> " "<refentrytitle>po-debconf</refentrytitle> <manvolnum>7</manvolnum> " -"</citerefentry>)." +"</citerefentry>." msgstr "" #. type: Content of: <chapter><section><title> @@ -1924,13 +1938,23 @@ msgstr "" msgid "Internationalization" msgstr "" -#. type: Content of: <chapter><section><section><title> +#. type: Content of: <chapter><section><para> #: best-pkging-practices.dbk:1364 +msgid "" +"This section contains global information for developers to make translators' " +"life easier. More information for translators and developers interrested in " +"internationalization are available in the <ulink " +"url=\"&url-i18n-l10n;\">Internationalisation and localisation in " +"Debian</ulink> documentation." +msgstr "" + +#. type: Content of: <chapter><section><section><title> +#: best-pkging-practices.dbk:1371 msgid "Handling debconf translations" msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1366 +#: best-pkging-practices.dbk:1373 msgid "" "Like porters, translators have a difficult task. They work on many packages " "and must collaborate with many different maintainers. Moreover, most of the " @@ -1939,7 +1963,7 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1372 +#: best-pkging-practices.dbk:1379 msgid "" "The goal of <systemitem role=\"package\">debconf</systemitem> was to make " "packages configuration easier for maintainers and for users. Originally, " @@ -1953,10 +1977,10 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1382 +#: best-pkging-practices.dbk:1389 msgid "" "Using <systemitem role=\"package\">po-debconf</systemitem>, the translation " -"is stored in <filename>po</filename> files (drawing from " +"is stored in <filename>.po</filename> files (drawing from " "<command>gettext</command> 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 " @@ -1970,12 +1994,12 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><title> -#: best-pkging-practices.dbk:1398 +#: best-pkging-practices.dbk:1405 msgid "Internationalized documentation" msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1400 +#: best-pkging-practices.dbk:1407 msgid "" "Internationalizing documentation is crucial for users, but a lot of labor. " "There's no way to eliminate all that work, but you can make things easier " @@ -1983,24 +2007,24 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1405 +#: best-pkging-practices.dbk:1412 msgid "" -"If you maintain documentation of any size, its easier for translators if " +"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 <ulink " "url=\"&url-i18n-doc-check;\">doc-check</ulink> in the <systemitem " -"role=\"package\">boot-floppies</systemitem> 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." +"role=\"package\">debian-installer</systemitem> 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 VCS area." msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1419 +#: best-pkging-practices.dbk:1426 msgid "" "If you maintain XML or SGML documentation, we suggest that you isolate any " "language-independent information and define those as entities in a separate " @@ -2008,18 +2032,29 @@ msgid "" "much easier, for instance, to keep URLs up to date across multiple files." msgstr "" +#. type: Content of: <chapter><section><section><para> +#: best-pkging-practices.dbk:1432 +msgid "" +"Some tools (e.g. <systemitem role=\"package\">po4a</systemitem>, <systemitem " +"role=\"package\">poxml</systemitem>, or the <systemitem " +"role=\"package\">translate-toolkit</systemitem>) are specialized in " +"extracting the translatable material from different formats. They produce " +"PO files, a format quite common to translators, which permits to see what " +"needs to be retranslated when the translated document is updated." +msgstr "" + #. type: Content of: <chapter><section><title> -#: best-pkging-practices.dbk:1429 +#: best-pkging-practices.dbk:1444 msgid "Common packaging situations" msgstr "" #. type: Content of: <chapter><section><section><title> -#: best-pkging-practices.dbk:1440 +#: best-pkging-practices.dbk:1455 msgid "Packages using <command>autoconf</command>/<command>automake</command>" msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1442 +#: best-pkging-practices.dbk:1457 msgid "" "Keeping <command>autoconf</command>'s <filename>config.sub</filename> and " "<filename>config.guess</filename> files up to date is critical for porters, " @@ -2032,12 +2067,12 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><title> -#: best-pkging-practices.dbk:1454 +#: best-pkging-practices.dbk:1469 msgid "Libraries" msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1456 +#: best-pkging-practices.dbk:1471 msgid "" "Libraries are always difficult to package for various reasons. The policy " "imposes many constraints to ease their maintenance and to make sure upgrades " @@ -2046,26 +2081,26 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1462 +#: best-pkging-practices.dbk:1477 msgid "" "Good practices for library packaging have been grouped in <ulink " "url=\"&url-libpkg-guide;\">the library packaging guide</ulink>." msgstr "" #. type: Content of: <chapter><section><section><title> -#: best-pkging-practices.dbk:1469 +#: best-pkging-practices.dbk:1484 msgid "Documentation" msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1471 +#: best-pkging-practices.dbk:1486 msgid "" "Be sure to follow the <ulink url=\"&url-debian-policy;ch-docs.html\">Policy " "on documentation</ulink>." msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1476 +#: best-pkging-practices.dbk:1491 msgid "" "If your package contains documentation built from XML or SGML, we recommend " "you not ship the XML or SGML source in the binary package(s). If users want " @@ -2073,7 +2108,7 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1481 +#: best-pkging-practices.dbk:1496 msgid "" "Policy specifies that documentation should be shipped in HTML format. We " "also recommend shipping documentation in PDF and plain text format if " @@ -2083,7 +2118,7 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1488 +#: best-pkging-practices.dbk:1503 msgid "" "Major shipped manuals should register themselves with <systemitem " "role=\"package\">doc-base</systemitem> on installation. See the <systemitem " @@ -2092,7 +2127,7 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1494 +#: best-pkging-practices.dbk:1509 msgid "" "Debian policy (section 12.1) directs that manual pages should accompany " "every program, utility, and function, and suggests them for other objects " @@ -2102,29 +2137,29 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1501 +#: best-pkging-practices.dbk:1516 msgid "" "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 <command>xsltproc</command>, <command>pod2man</command> and " -"<command>rst2man</command> respectively. To a lesser extent, the <command> " -"help2man</command>program can also be used to write a stub." +"<command>rst2man</command> respectively. To a lesser extent, the " +"<command>help2man</command> program can also be used to write a stub." msgstr "" #. type: Content of: <chapter><section><section><title> -#: best-pkging-practices.dbk:1510 +#: best-pkging-practices.dbk:1525 msgid "Specific types of packages" msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1512 +#: best-pkging-practices.dbk:1527 msgid "" "Several specific types of packages have special sub-policies and " "corresponding packaging rules and practices:" msgstr "" #. type: Content of: <chapter><section><section><itemizedlist><listitem><para> -#: best-pkging-practices.dbk:1518 +#: best-pkging-practices.dbk:1533 msgid "" "Perl related packages have a <ulink url=\"&url-perl-policy;\">Perl " "policy</ulink>, some examples of packages following that policy are " @@ -2134,28 +2169,28 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><itemizedlist><listitem><para> -#: best-pkging-practices.dbk:1527 +#: best-pkging-practices.dbk:1542 msgid "" "Python related packages have their python policy; see &file-python-policy; " "in the <systemitem role=\"package\">python</systemitem> package." msgstr "" #. type: Content of: <chapter><section><section><itemizedlist><listitem><para> -#: best-pkging-practices.dbk:1534 +#: best-pkging-practices.dbk:1549 msgid "" "Emacs related packages have the <ulink url=\"&url-emacs-policy;\">emacs " "policy</ulink>." msgstr "" #. type: Content of: <chapter><section><section><itemizedlist><listitem><para> -#: best-pkging-practices.dbk:1541 +#: best-pkging-practices.dbk:1556 msgid "" "Java related packages have their <ulink url=\"&url-java-policy;\">java " "policy</ulink>." msgstr "" #. type: Content of: <chapter><section><section><itemizedlist><listitem><para> -#: best-pkging-practices.dbk:1548 +#: best-pkging-practices.dbk:1563 msgid "" "Ocaml related packages have their own policy, found in &file-ocaml-policy; " "from the <systemitem role=\"package\">ocaml</systemitem> package. A good " @@ -2164,7 +2199,7 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><itemizedlist><listitem><para> -#: best-pkging-practices.dbk:1556 +#: best-pkging-practices.dbk:1571 msgid "" "Packages providing XML or SGML DTDs should conform to the recommendations " "found in the <systemitem role=\"package\">sgml-base-doc</systemitem> " @@ -2172,7 +2207,7 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><itemizedlist><listitem><para> -#: best-pkging-practices.dbk:1562 +#: best-pkging-practices.dbk:1577 msgid "" "Lisp packages should register themselves with <systemitem " "role=\"package\">common-lisp-controller</systemitem>, about which see " @@ -2180,12 +2215,12 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><title> -#: best-pkging-practices.dbk:1592 +#: best-pkging-practices.dbk:1607 msgid "Architecture-independent data" msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1594 +#: best-pkging-practices.dbk:1609 msgid "" "It is not uncommon to have a large amount of architecture-independent data " "packaged with a program. For example, audio files, a collection of icons, " @@ -2195,32 +2230,33 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1601 +#: best-pkging-practices.dbk:1616 msgid "" "However, if the size of the data is considerable, consider splitting it out " -"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 <filename>Packages</filename> files, it saves a lot of disk space on " -"Debian mirrors. Separating out architecture-independent data also reduces " +"into a separate, architecture-independent package " +"(<filename>_all.deb</filename>). 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 " +"<filename>Packages</filename> files, it saves a lot of disk space on Debian " +"mirrors. Separating out architecture-independent data also reduces " "processing time of <command>lintian</command> (see <xref " -"linkend=\"tools-lint\"/> ) when run over the entire Debian archive." +"linkend=\"tools-lint\"/>) when run over the entire Debian archive." msgstr "" #. type: Content of: <chapter><section><section><title> -#: best-pkging-practices.dbk:1613 +#: best-pkging-practices.dbk:1628 msgid "Needing a certain locale during build" msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1615 +#: best-pkging-practices.dbk:1630 msgid "" "If you need a certain locale during build, you can create a temporary file " "via this trick:" msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1619 +#: best-pkging-practices.dbk:1634 msgid "" "If you set <varname>LOCPATH</varname> to the equivalent of " "<filename>/usr/lib/locale</filename>, and <varname>LC_ALL</varname> to the " @@ -2229,7 +2265,7 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><screen> -#: best-pkging-practices.dbk:1624 +#: best-pkging-practices.dbk:1639 #, no-wrap msgid "" "LOCALE_PATH=debian/tmpdir/usr/lib/locale\n" @@ -2245,12 +2281,12 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><title> -#: best-pkging-practices.dbk:1637 +#: best-pkging-practices.dbk:1652 msgid "Make transition packages deborphan compliant" msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1639 +#: best-pkging-practices.dbk:1654 msgid "" "Deborphan is a program for helping users to detect which packages can safely " "be removed from the system, i.e. the ones that have no packages depending " @@ -2260,7 +2296,7 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1646 +#: best-pkging-practices.dbk:1661 msgid "" "For example, with <literal>--guess-dummy</literal>, " "<command>deborphan</command> tries to search all transitional packages which " @@ -2269,7 +2305,7 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1653 +#: best-pkging-practices.dbk:1668 msgid "" "So, when you are creating such a package, please make sure to add this text " "to your short description. If you are looking for examples, just run: " @@ -2277,25 +2313,33 @@ msgid "" "search .|grep transitional</command>." msgstr "" +#. type: Content of: <chapter><section><section><para> +#: best-pkging-practices.dbk:1674 +msgid "" +"Also, it is recommended to adjust its section to <literal>oldlibs</literal> " +"and its priority to <literal>extra</literal> in order to ease " +"<command>deborphan</command>'s job." +msgstr "" + #. type: Content of: <chapter><section><section><title> -#: best-pkging-practices.dbk:1661 -msgid "Best practices for <filename>orig.tar.gz</filename> files" +#: best-pkging-practices.dbk:1683 +msgid "Best practices for <filename>.orig.tar.{gz,bz2,lzma}</filename> files" msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1663 +#: best-pkging-practices.dbk:1685 msgid "" "There are two kinds of original source tarballs: Pristine source and " "repackaged upstream source." msgstr "" #. type: Content of: <chapter><section><section><section><title> -#: best-pkging-practices.dbk:1667 +#: best-pkging-practices.dbk:1689 msgid "Pristine source" msgstr "" #. type: Content of: <chapter><section><section><section><para><footnote><para> -#: best-pkging-practices.dbk:1671 +#: best-pkging-practices.dbk:1693 msgid "" "We cannot prevent upstream authors from changing the tarball they distribute " "without also incrementing the version number, so there can be no guarantee " @@ -2306,16 +2350,16 @@ msgid "" "upstream notices that he wasn't using maximal compression in his original " "distribution and then re-<command>gzip</command>s it), that's just too bad. " "Since there is no good way to upload a new " -"<literal>.orig.tar.{gz,bz2}</literal> for the same version, there is not " -"even any point in treating this situation as a bug." +"<filename>.orig.tar.{gz,bz2,lzma}</filename> for the same version, there is " +"not even any point in treating this situation as a bug." msgstr "" #. type: Content of: <chapter><section><section><section><para> -#: best-pkging-practices.dbk:1669 +#: best-pkging-practices.dbk:1691 msgid "" "The defining characteristic of a pristine source tarball is that the " -"<literal>.orig.tar.{gz,bz2}</literal> file is byte-for-byte identical to a " -"tarball officially distributed by the upstream author. <placeholder " +"<filename>.orig.tar.{gz,bz2,lzma}</filename> file is byte-for-byte identical " +"to a tarball officially distributed by the upstream author.<placeholder " "type=\"footnote\" id=\"0\"/> 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 source is huge, " @@ -2324,7 +2368,7 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><section><para> -#: best-pkging-practices.dbk:1689 +#: best-pkging-practices.dbk:1711 msgid "" "There is no universally accepted guidelines that upstream authors follow " "regarding to the directory structure inside their tarball, but " @@ -2334,45 +2378,46 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para> -#: best-pkging-practices.dbk:1697 +#: best-pkging-practices.dbk:1719 msgid "It unpacks the tarball in an empty temporary directory by doing" msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><screen> -#: best-pkging-practices.dbk:1700 +#: best-pkging-practices.dbk:1722 #, no-wrap msgid "" -"zcat path/to/<packagename>_<upstream-version>.orig.tar.gz | tar " -"xf -\n" +"zcat " +"path/to/<replaceable>packagename</replaceable>_<replaceable>upstream-version</replaceable>.orig.tar.gz " +"| tar xf -\n" msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para> -#: best-pkging-practices.dbk:1705 +#: best-pkging-practices.dbk:1727 msgid "" "If, after this, the temporary directory contains nothing but one directory " "and no other files, <command>dpkg-source</command> renames that directory to " -"<literal><packagename>-<upstream-version>(.orig)</literal>. The " -"name of the top-level directory in the tarball does not matter, and is " +"<filename><replaceable>packagename</replaceable>-<replaceable>upstream-version</replaceable>(.orig)</filename>. " +"The name of the top-level directory in the tarball does not matter, and is " "forgotten." msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para> -#: best-pkging-practices.dbk:1714 +#: best-pkging-practices.dbk:1736 msgid "" "Otherwise, the upstream tarball must have been packaged without a common " "top-level directory (shame on the upstream author!). In this case, " "<command>dpkg-source</command> renames the temporary directory " "<emphasis>itself</emphasis> to " -"<literal><packagename>-<upstream-version>(.orig)</literal>." +"<filename><replaceable>packagename</replaceable>-<replaceable>upstream-version</replaceable>(.orig)</filename>." msgstr "" #. type: Content of: <chapter><section><section><section><title> -#: best-pkging-practices.dbk:1725 +#: best-pkging-practices.dbk:1747 msgid "Repackaged upstream source" msgstr "" #. type: Content of: <chapter><section><section><section><para> -#: best-pkging-practices.dbk:1727 +#: best-pkging-practices.dbk:1749 msgid "" "You <emphasis role=\"strong\">should</emphasis> upload packages with a " "pristine source tarball if possible, but there are various reasons why it " @@ -2382,24 +2427,25 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><section><para> -#: best-pkging-practices.dbk:1734 +#: best-pkging-practices.dbk:1756 msgid "" "In these cases the developer must construct a suitable " -"<literal>.orig.tar.{gz,bz2} </literal> file himself. We refer to such a " -"tarball as a repackaged upstream source. Note that a repackaged upstream " +"<filename>.orig.tar.{gz,bz2,lzma}</filename> 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 <literal>.diff.gz</literal> " -"or <literal>.debian.tar.{gz,bz2}</literal> and still has a version number " -"composed of <literal><upstream-version></literal> and " -"<literal><debian-revision></literal>." +"comes with Debian-specific changes in a separate " +"<filename>.diff.gz</filename> or " +"<filename>.debian.tar.{gz,bz2,lzma}</filename> and still has a version " +"number composed of <replaceable>upstream-version</replaceable> and " +"<replaceable>debian-version</replaceable>." msgstr "" #. type: Content of: <chapter><section><section><section><para> -#: best-pkging-practices.dbk:1743 +#: best-pkging-practices.dbk:1765 msgid "" "There may be cases where it is desirable to repackage the source even though " -"upstream distributes a <literal>.tar.gz</literal> that could in principle be " -"used in its pristine form. The most obvious is if " +"upstream distributes a <filename>.tar.{gz,bz2,lzma}</filename> that could in " +"principle be used in its pristine form. The most obvious is if " "<emphasis>significant</emphasis> space savings can be achieved by " "recompressing the tar archive or by removing genuinely useless cruft from " "the upstream archive. Use your own discretion here, but be prepared to " @@ -2407,56 +2453,58 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><section><para> -#: best-pkging-practices.dbk:1752 -msgid "A repackaged <literal>.orig.tar.{gz,bz2}</literal>" +#: best-pkging-practices.dbk:1774 +msgid "A repackaged <filename>.orig.tar.{gz,bz2,lzma}</filename>" msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para> -#: best-pkging-practices.dbk:1757 +#: best-pkging-practices.dbk:1779 msgid "" -"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 <filename>debian/copyright</filename>. It is also a " -"good idea to provide a <literal>get-orig-source</literal> target in your " +"<emphasis role=\"strong\">should</emphasis> 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 " +"<filename>debian/copyright</filename>. It is also a good idea to provide a " +"<literal>get-orig-source</literal> target in your " "<filename>debian/rules</filename> file that repeats the process, as " "described in the Policy Manual, <ulink " "url=\"&url-debian-policy;ch-source.html#s-debianrules\">Main building " -"script: debian/rules</ulink>." +"script: <filename>debian/rules</filename></ulink>." msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para><footnote><para> -#: best-pkging-practices.dbk:1772 +#: best-pkging-practices.dbk:1794 msgid "" "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 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 of the source." +"them, and/or explain the situation in a <filename>README.source</filename> " +"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 separable from the " +"rest of the source." msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para> -#: best-pkging-practices.dbk:1770 +#: best-pkging-practices.dbk:1792 msgid "" "<emphasis role=\"strong\">should not</emphasis> contain any file that does " "not come from the upstream author(s), or whose contents has been changed by " -"you. <placeholder type=\"footnote\" id=\"0\"/>" +"you.<placeholder type=\"footnote\" id=\"0\"/>" msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para> -#: best-pkging-practices.dbk:1783 +#: best-pkging-practices.dbk:1805 msgid "" "<emphasis role=\"strong\">should</emphasis>, except where impossible for " "legal 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 your <filename>debian/rules</filename> does is to overwrite it " -"by running a configure script." +"Similarly, a <filename>Makefile</filename> provided by upstream should not " +"be omitted even if the first thing your <filename>debian/rules</filename> " +"does is to overwrite it by running a configure script." msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para> -#: best-pkging-practices.dbk:1792 +#: best-pkging-practices.dbk:1814 msgid "" "(<emphasis>Rationale:</emphasis> It is common for Debian users who need to " "build software for non-Debian platforms to fetch the source from a Debian " @@ -2465,28 +2513,28 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para> -#: best-pkging-practices.dbk:1799 +#: best-pkging-practices.dbk:1821 msgid "" "<emphasis role=\"strong\">should</emphasis> use " -"<literal><packagename>-<upstream-version>.orig</literal> as the " -"name of the top-level directory in its tarball. This makes it possible to " -"distinguish pristine tarballs from repackaged ones." +"<filename><replaceable>packagename</replaceable>-<replaceable>upstream-version</replaceable>.orig</filename> " +"as the name of the top-level directory in its tarball. This makes it " +"possible to distinguish pristine tarballs from repackaged ones." msgstr "" #. type: Content of: <chapter><section><section><section><orderedlist><listitem><para> -#: best-pkging-practices.dbk:1807 +#: best-pkging-practices.dbk:1829 msgid "" "<emphasis role=\"strong\">should</emphasis> be gzipped or bzipped with " "maximal compression." msgstr "" #. type: Content of: <chapter><section><section><section><title> -#: best-pkging-practices.dbk:1814 +#: best-pkging-practices.dbk:1836 msgid "Changing binary files" msgstr "" #. type: Content of: <chapter><section><section><section><para> -#: best-pkging-practices.dbk:1816 +#: best-pkging-practices.dbk:1838 msgid "" "Sometimes it is necessary to change binary files contained in the original " "tarball, or to add binary files that are not in it. This is fully supported " @@ -2500,23 +2548,24 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><title> -#: best-pkging-practices.dbk:1831 +#: best-pkging-practices.dbk:1853 msgid "Best practices for debug packages" msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1833 +#: best-pkging-practices.dbk:1855 msgid "" "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 default, debugging information, including function names and line " -"numbers, is 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." +"additional information that <command>gdb</command> can use. Since Debian " +"binaries are stripped by default, debugging information, including function " +"names and line numbers, is otherwise not available when running " +"<command>gdb</command> on Debian binaries. Debug packages allow users who " +"need this additional debugging information to install it, without bloating a " +"regular system with the information." msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1841 +#: best-pkging-practices.dbk:1863 msgid "" "It is up to a package's maintainer whether to create a debug package or " "not. Maintainers are encouraged to create debug packages for library " @@ -2529,13 +2578,13 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1851 +#: best-pkging-practices.dbk:1873 msgid "" "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 when debugging a program or library. The convention in Debian is to " -"keep these symbols in " +"instead containing separated debugging symbols that <command>gdb</command> " +"can find and load on the fly when debugging a program or library. The " +"convention in Debian is to keep these symbols in " "<filename>/usr/lib/debug/<replaceable>path</replaceable></filename>, where " "<replaceable>path</replaceable> is the path to the executable or library. " "For example, debugging symbols for <filename>/usr/bin/foo</filename> go in " @@ -2545,28 +2594,30 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1863 +#: best-pkging-practices.dbk:1885 msgid "" -"The debugging symbols can be extracted from an object file using <command> " -"objcopy --only-keep-debug</command>. Then the object file can be stripped, " -"and <command>objcopy --add-gnu-debuglink</command> used to specify the path " -"to the debugging symbol file. <citerefentry> " +"The debugging symbols can be extracted from an object file using " +"<command>objcopy --only-keep-debug</command>. Then the object file can be " +"stripped, and <command>objcopy --add-gnu-debuglink</command> used to specify " +"the path to the debugging symbol file. <citerefentry> " "<refentrytitle>objcopy</refentrytitle> <manvolnum>1</manvolnum> " "</citerefentry> explains in detail how this works." msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1871 +#: best-pkging-practices.dbk:1893 msgid "" -"The <command>dh_strip</command> command in debhelper supports creating debug " -"packages, and can take care of using <command>objcopy</command> to separate " -"out the debugging symbols for you. If your package uses debhelper, all you " -"need to do is call <command>dh_strip --dbg-package=libfoo-dbg</command>, and " -"add an entry to <filename>debian/control</filename> for the debug package." +"The <command>dh_strip</command> command in <systemitem " +"role=\"package\">debhelper</systemitem> supports creating debug packages, " +"and can take care of using <command>objcopy</command> to separate out the " +"debugging symbols for you. If your package uses <systemitem " +"role=\"package\">debhelper</systemitem>, all you need to do is call " +"<command>dh_strip --dbg-package=libfoo-dbg</command>, and add an entry to " +"<filename>debian/control</filename> for the debug package." msgstr "" #. type: Content of: <chapter><section><section><para> -#: best-pkging-practices.dbk:1878 +#: best-pkging-practices.dbk:1900 msgid "" "Note that the debug package should depend on the package that it provides " "debugging symbols for, and this dependency should be versioned. For " @@ -2574,7 +2625,41 @@ msgid "" msgstr "" #. type: Content of: <chapter><section><section><screen> -#: best-pkging-practices.dbk:1882 +#: best-pkging-practices.dbk:1904 #, no-wrap msgid "Depends: libfoo (= ${binary:Version})\n" msgstr "" + +#. type: Content of: <chapter><section><section><title> +#: best-pkging-practices.dbk:1908 +msgid "Best practices for meta-packages" +msgstr "" + +#. type: Content of: <chapter><section><section><para> +#: best-pkging-practices.dbk:1910 +msgid "" +"A meta-package is a mostly empty package that makes it easy to install a " +"coherent set of packages that can evolve over time. It achieves this by " +"depending on all the packages of the set. Thanks to the power of APT, the " +"meta-package maintainer can adjust the dependencies and the user's system " +"will automatically get the supplementary packages. The dropped packages that " +"were automatically installed will be also be marked as removal candidates " +"(and are even automatically removed by <command>aptitude</command>). " +"<systemitem role=\"package\">gnome</systemitem> and <systemitem " +"role=\"package\">linux-image-amd64</systemitem> are two examples of " +"meta-packages (built by the source packages <systemitem " +"role=\"package\">meta-gnome2</systemitem> and <systemitem " +"role=\"package\">linux-latest</systemitem>)." +msgstr "" + +#. type: Content of: <chapter><section><section><para> +#: best-pkging-practices.dbk:1924 +msgid "" +"The long description of the meta-package must clearly document its purpose " +"so that the user knows what he will lose if he removes the package. Being " +"explicit about the consequences is recommended. This is particularly " +"important for meta-packages which are installed during initial installation " +"and that have not been explicitly installed by the user. Those tend to be " +"important to ensure smooth system upgrades and the user should be " +"discouraged from uninstalling them to avoid potential breakages." +msgstr ""