msgid ""
msgstr ""
"Project-Id-Version: PACKAGE VERSION\n"
-"POT-Creation-Date: 2010-05-06 17:34-0400\n"
+"POT-Creation-Date: 2012-01-10 17:56-0400\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\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: <chapter><title>
#: best-pkging-practices.dbk:7
"<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 "
"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 ""
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>
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>
#. 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>
"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>
#. 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>
#. 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 "
#. 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>
#. 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>
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>
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>
#: 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>
#. type: Content of: <chapter><section><section><section><para>
#: best-pkging-practices.dbk:833
msgid ""
-"To <emphasis>unfuzzy</emphasis> translations, you can use two methods. The "
-"first method does <emphasis>preventive</emphasis> search and replace actions "
-"in the PO files. The latter uses <command>gettext</command> utilities to "
-"<emphasis>unfuzzy</emphasis> strings."
-msgstr ""
-
-#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:839
-msgid "<emphasis>Preventive unfuzzy</emphasis> method:"
+"To <emphasis>unfuzzy</emphasis> translations, you can use "
+"<command>msguntypot</command> (part of the <systemitem "
+"role=\"package\">po4a</systemitem> package)."
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:"
+#: best-pkging-practices.dbk:840
+msgid "Regenerate the POT and PO files."
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:842 best-pkging-practices.dbk:865
#, no-wrap
-msgid ""
-"for i in debian/po/*po; do echo -n $i: ; msgfmt -o /dev/null\n"
-"--statistics $i; done"
-msgstr ""
-
-#. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
-#: best-pkging-practices.dbk:850
-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 "
-"care to properly interact with translators), you should use the file with "
-"the most translated strings."
-msgstr ""
-
-#. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
-#: best-pkging-practices.dbk:858
-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 "
-"inadvertently written as <literal>tpyo</literal>. Therefore, the change is "
-"<command>s/tpyo/typo</command>."
-msgstr ""
-
-#. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
-#: best-pkging-practices.dbk:866
-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 "
-"where the original string is appropriate. This specifically applies to "
-"change in punctuation, for instance."
+msgid "debconf-updatepo"
msgstr ""
#. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
-#: best-pkging-practices.dbk:874
-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."
+#: best-pkging-practices.dbk:846
+msgid "Make a copy of the POT file."
msgstr ""
#. type: Content of: <chapter><section><section><section><orderedlist><listitem><programlisting>
-#: best-pkging-practices.dbk:879
+#: best-pkging-practices.dbk:848
#, no-wrap
-msgid ""
-"cd debian/po\n"
-"for i in *.po; do sed -i 's/tpyo/typo/g' $i; done\n"
+msgid "cp templates.pot templates.pot.orig"
msgstr ""
#. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
-#: best-pkging-practices.dbk:885
-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>"
-msgstr ""
-
-#. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
-#: best-pkging-practices.dbk:895
-msgid ""
-"Check the <filename>foo.po</filename> reference file. Its statistics should "
-"not be changed:"
+#: best-pkging-practices.dbk:852
+msgid "Make a copy of all the PO files."
msgstr ""
#. type: Content of: <chapter><section><section><section><orderedlist><listitem><programlisting>
-#: best-pkging-practices.dbk:899
+#: best-pkging-practices.dbk:854
#, no-wrap
-msgid "msgfmt -o /dev/null --statistics debian/po/foo.po\n"
+msgid "mkdir po_fridge; cp *.po po_fridge"
msgstr ""
-#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:908
-msgid "Gettext utilities method:"
+#. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
+#: best-pkging-practices.dbk:858
+msgid "Change the debconf template files to fix the typos."
msgstr ""
#. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
-#: best-pkging-practices.dbk:913
-msgid ""
-"Put all incomplete PO files out of the way. You can check the completeness "
-"by using (needs the <systemitem role=\"package\">gettext</systemitem> "
-"package installed):"
+#: best-pkging-practices.dbk:863
+msgid "Regenerate the POT and PO files (again)."
msgstr ""
#. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
-#: best-pkging-practices.dbk:922
+#: best-pkging-practices.dbk:867
msgid ""
-"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."
+"At this point, the typo fix fuzzied all the translations, and this "
+"unfortunate change is the only one between the PO files of your main "
+"directory and the one from the fridge. Here is how to solve this."
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 "
-"for the typos and check again that translation are not impacted (typos, "
-"spelling errors, sometimes typographical corrections are usually OK)"
+#: best-pkging-practices.dbk:874
+msgid "Discard fuzzy translation, restore the ones from the fridge."
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"
+#. type: Content of: <chapter><section><section><section><orderedlist><listitem><programlisting>
+#: best-pkging-practices.dbk:876
+#, no-wrap
+msgid "cp po_fridge/*.po ."
msgstr ""
#. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
-#: best-pkging-practices.dbk:942
-msgid "use the following command:"
+#: best-pkging-practices.dbk:880
+msgid ""
+"Manually merge the PO files with the new POT file, but taking the useless "
+"fuzzy into account."
msgstr ""
#. type: Content of: <chapter><section><section><section><orderedlist><listitem><programlisting>
-#: best-pkging-practices.dbk:944
+#: best-pkging-practices.dbk:882
#, no-wrap
-msgid "for i in debian/po/*po; do msgattrib --output-file=$i --clear-fuzzy $i; done"
+msgid "msguntypot -o templates.pot.orig -n templates.pot *.po"
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"
+#: best-pkging-practices.dbk:886
+msgid "Clean up."
msgstr ""
-#. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
-#: best-pkging-practices.dbk:953
-msgid "run <command>debconf-updatepo</command> again"
+#. type: Content of: <chapter><section><section><section><orderedlist><listitem><programlisting>
+#: best-pkging-practices.dbk:888
+#, no-wrap
+msgid "rm -rf templates.pot.orig po_fridge"
msgstr ""
#. type: Content of: <chapter><section><section><section><title>
-#: best-pkging-practices.dbk:960
+#: best-pkging-practices.dbk:894
msgid "Do not make assumptions about interfaces"
msgstr ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:962
+#: best-pkging-practices.dbk:896
msgid ""
"Templates text should not make reference to widgets belonging to some "
"debconf interfaces. Sentences like <emphasis>If you answer "
msgstr ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:967
+#: best-pkging-practices.dbk:901
msgid ""
"String templates should also avoid mentioning the default values in their "
"description. First, because this is redundant with the values seen by the "
msgstr ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:973
+#: best-pkging-practices.dbk:907
msgid ""
"More generally speaking, try to avoid referring to user actions. Just give "
"facts."
msgstr ""
#. type: Content of: <chapter><section><section><section><title>
-#: best-pkging-practices.dbk:979
+#: best-pkging-practices.dbk:913
msgid "Do not use first person"
msgstr ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:981
+#: best-pkging-practices.dbk:915
msgid ""
"You should avoid the use of first person (<emphasis>I will do "
"this...</emphasis> or <emphasis>We recommend...</emphasis>). The computer "
msgstr ""
#. type: Content of: <chapter><section><section><section><title>
-#: best-pkging-practices.dbk:991
+#: best-pkging-practices.dbk:925
msgid "Be gender neutral"
msgstr ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:993
+#: best-pkging-practices.dbk:927
msgid ""
"The world is made of men and women. Please use gender-neutral constructions "
"in your writing."
msgstr ""
#. type: Content of: <chapter><section><section><title>
-#: best-pkging-practices.dbk:1001
+#: best-pkging-practices.dbk:935
msgid "Templates fields definition"
msgstr ""
#. type: Content of: <chapter><section><section><para>
-#: best-pkging-practices.dbk:1003
+#: best-pkging-practices.dbk:937
msgid ""
"This part gives some information which is mostly taken from the "
"<citerefentry> <refentrytitle>debconf-devel</refentrytitle> "
msgstr ""
#. type: Content of: <chapter><section><section><section><title>
-#: best-pkging-practices.dbk:1008
+#: best-pkging-practices.dbk:942
msgid "Type"
msgstr ""
#. type: Content of: <chapter><section><section><section><section><title>
-#: best-pkging-practices.dbk:1010
-msgid "string:"
+#: best-pkging-practices.dbk:944
+msgid "string"
msgstr ""
#. type: Content of: <chapter><section><section><section><section><para>
-#: best-pkging-practices.dbk:1012
+#: best-pkging-practices.dbk:946
msgid "Results in a free-form input field that the user can type any string into."
msgstr ""
#. type: Content of: <chapter><section><section><section><section><title>
-#: best-pkging-practices.dbk:1017
-msgid "password:"
+#: best-pkging-practices.dbk:951
+msgid "password"
msgstr ""
#. type: Content of: <chapter><section><section><section><section><para>
-#: best-pkging-practices.dbk:1019
+#: best-pkging-practices.dbk:953
msgid ""
"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 "
msgstr ""
#. type: Content of: <chapter><section><section><section><section><title>
-#: best-pkging-practices.dbk:1026
-msgid "boolean:"
+#: best-pkging-practices.dbk:960
+msgid "boolean"
msgstr ""
#. type: Content of: <chapter><section><section><section><section><para>
-#: best-pkging-practices.dbk:1028
+#: best-pkging-practices.dbk:962
msgid ""
"A true/false choice. Remember: true/false, <emphasis role=\"strong\">not "
"yes/no</emphasis>..."
msgstr ""
#. type: Content of: <chapter><section><section><section><section><title>
-#: best-pkging-practices.dbk:1034
-msgid "select:"
+#: best-pkging-practices.dbk:968
+msgid "select"
msgstr ""
#. type: Content of: <chapter><section><section><section><section><para>
-#: best-pkging-practices.dbk:1036
+#: best-pkging-practices.dbk:970
msgid ""
"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 "
msgstr ""
#. type: Content of: <chapter><section><section><section><section><para>
-#: best-pkging-practices.dbk:1041
+#: best-pkging-practices.dbk:975
msgid ""
"If choices are translatable strings, the 'Choices' field may be marked as "
"translatable by using <literal>__Choices</literal>. The double underscore "
msgstr ""
#. type: Content of: <chapter><section><section><section><section><para>
-#: best-pkging-practices.dbk:1046
+#: best-pkging-practices.dbk:980
msgid ""
"The <command>po-debconf</command> system also offers interesting "
"possibilities to only mark <emphasis role=\"strong\">some</emphasis> choices "
msgstr ""
#. type: Content of: <chapter><section><section><section><section><programlisting>
-#: best-pkging-practices.dbk:1051
+#: best-pkging-practices.dbk:985
#, no-wrap
msgid ""
"Template: foo/bar\n"
msgstr ""
#. type: Content of: <chapter><section><section><section><section><para>
-#: best-pkging-practices.dbk:1059
+#: best-pkging-practices.dbk:993
msgid ""
"In that example, only the 'Other' string is translatable while others are "
"acronyms that should not be translated. The above allows only 'Other' to be "
msgstr ""
#. type: Content of: <chapter><section><section><section><section><para>
-#: best-pkging-practices.dbk:1064
+#: best-pkging-practices.dbk:998
msgid ""
"The debconf templates flag system offers many such possibilities. The "
"<citerefentry> <refentrytitle>po-debconf</refentrytitle> "
msgstr ""
#. type: Content of: <chapter><section><section><section><section><title>
-#: best-pkging-practices.dbk:1072
-msgid "multiselect:"
+#: best-pkging-practices.dbk:1006
+msgid "multiselect"
msgstr ""
#. type: Content of: <chapter><section><section><section><section><para>
-#: best-pkging-practices.dbk:1074
+#: best-pkging-practices.dbk:1008
msgid ""
"Like the select data type, except the user can choose any number of items "
"from the choices list (or chose none of them)."
msgstr ""
#. type: Content of: <chapter><section><section><section><section><title>
-#: best-pkging-practices.dbk:1080
-msgid "note:"
+#: best-pkging-practices.dbk:1014
+msgid "note"
msgstr ""
#. type: Content of: <chapter><section><section><section><section><para>
-#: best-pkging-practices.dbk:1082
+#: best-pkging-practices.dbk:1016
msgid ""
"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 "
msgstr ""
#. type: Content of: <chapter><section><section><section><section><title>
-#: best-pkging-practices.dbk:1091
-msgid "text:"
+#: best-pkging-practices.dbk:1025
+msgid "text"
msgstr ""
#. type: Content of: <chapter><section><section><section><section><para>
-#: best-pkging-practices.dbk:1093
+#: best-pkging-practices.dbk:1027
msgid "This type is now considered obsolete: don't use it."
msgstr ""
#. type: Content of: <chapter><section><section><section><section><title>
-#: best-pkging-practices.dbk:1098
-msgid "error:"
+#: best-pkging-practices.dbk:1032
+msgid "error"
msgstr ""
#. type: Content of: <chapter><section><section><section><section><para>
-#: best-pkging-practices.dbk:1100
+#: best-pkging-practices.dbk:1034
msgid ""
"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 "
msgstr ""
#. type: Content of: <chapter><section><section><section><section><para>
-#: best-pkging-practices.dbk:1105
+#: best-pkging-practices.dbk:1039
msgid ""
"It is recommended to use this type for any message that needs user attention "
"for a correction of any kind."
msgstr ""
#. type: Content of: <chapter><section><section><section><title>
-#: best-pkging-practices.dbk:1113
+#: best-pkging-practices.dbk:1047
msgid "Description: short and extended description"
msgstr ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:1115
+#: best-pkging-practices.dbk:1049
msgid ""
"Template descriptions have two parts: short and extended. The short "
"description is in the Description: line of the template."
msgstr ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:1119
+#: best-pkging-practices.dbk:1053
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 ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:1125
+#: best-pkging-practices.dbk:1059
msgid ""
"The short description should be able to stand on its own. Some interfaces "
"do not show the long description by default, or only if the user explicitely "
msgstr ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:1131
+#: best-pkging-practices.dbk:1065
msgid ""
"The short description does not necessarily have to be a full sentence. This "
"is part of the keep it short and efficient recommendation."
msgstr ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:1135
+#: best-pkging-practices.dbk:1069
msgid ""
"The extended description should not repeat the short description word for "
"word. If you can't think up a long description, then first, think some "
msgstr ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:1142
+#: best-pkging-practices.dbk:1076
msgid ""
"The extended description should use complete sentences. Paragraphs should "
"be kept short for improved readability. Do not mix two ideas in the same "
msgstr ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:1147
+#: best-pkging-practices.dbk:1081
msgid ""
"Don't be too verbose. User tend to ignore too long screens. 20 lines are "
"by experience a border you shouldn't cross, because that means that in the "
msgstr ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:1153
+#: best-pkging-practices.dbk:1087
msgid ""
"The extended description should <emphasis role=\"strong\">never</emphasis> "
"include a question."
msgstr ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:1157
+#: best-pkging-practices.dbk:1091
msgid ""
"For specific rules depending on templates type (string, boolean, etc.), "
"please read below."
msgstr ""
#. type: Content of: <chapter><section><section><section><title>
-#: best-pkging-practices.dbk:1163
+#: best-pkging-practices.dbk:1097
msgid "Choices"
msgstr ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:1165
+#: best-pkging-practices.dbk:1099
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 ""
#. type: Content of: <chapter><section><section><section><title>
-#: best-pkging-practices.dbk:1172
+#: best-pkging-practices.dbk:1106
msgid "Default"
msgstr ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:1174
+#: best-pkging-practices.dbk:1108
msgid ""
"This field is optional. It contains the default answer for string, select "
"and multiselect templates. For multiselect templates, it may contain a "
msgstr ""
#. type: Content of: <chapter><section><section><title>
-#: best-pkging-practices.dbk:1183
+#: best-pkging-practices.dbk:1117
msgid "Templates fields specific style guide"
msgstr ""
#. type: Content of: <chapter><section><section><section><title>
-#: best-pkging-practices.dbk:1185
+#: best-pkging-practices.dbk:1119
msgid "Type field"
msgstr ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:1187
+#: best-pkging-practices.dbk:1121
msgid ""
"No specific indication except: use the appropriate type by referring to the "
"previous section."
msgstr ""
#. type: Content of: <chapter><section><section><section><title>
-#: best-pkging-practices.dbk:1193
+#: best-pkging-practices.dbk:1127
msgid "Description field"
msgstr ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:1195
+#: best-pkging-practices.dbk:1129
msgid ""
"Below are specific instructions for properly writing the Description (short "
"and extended) depending on the template type."
msgstr ""
#. type: Content of: <chapter><section><section><section><section><title>
-#: best-pkging-practices.dbk:1199
+#: best-pkging-practices.dbk:1133
msgid "String/password templates"
msgstr ""
#. type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
-#: best-pkging-practices.dbk:1203
+#: best-pkging-practices.dbk:1137
msgid ""
"The short description is a prompt and <emphasis "
"role=\"strong\">not</emphasis> a title. Avoid question style prompts (IP "
msgstr ""
#. type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
-#: best-pkging-practices.dbk:1210
+#: best-pkging-practices.dbk:1144
msgid ""
"The extended description is a complement to the short description. In the "
"extended part, explain what is being asked, rather than ask the same "
msgstr ""
#. type: Content of: <chapter><section><section><section><section><title>
-#: best-pkging-practices.dbk:1220
+#: best-pkging-practices.dbk:1154
msgid "Boolean templates"
msgstr ""
#. type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
-#: best-pkging-practices.dbk:1224
+#: best-pkging-practices.dbk:1158
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>
-#: best-pkging-practices.dbk:1232
+#: best-pkging-practices.dbk:1166
msgid ""
"Again, please avoid referring to specific interface widgets. A common "
"mistake for such templates is if you answer Yes-type constructions."
msgstr ""
#. type: Content of: <chapter><section><section><section><section><title>
-#: best-pkging-practices.dbk:1240
+#: best-pkging-practices.dbk:1174
msgid "Select/Multiselect"
msgstr ""
#. type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
-#: best-pkging-practices.dbk:1244
+#: best-pkging-practices.dbk:1178
msgid ""
"The short description is a prompt and <emphasis "
"role=\"strong\">not</emphasis> a title. Do <emphasis "
msgstr ""
#. type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
-#: best-pkging-practices.dbk:1252
+#: best-pkging-practices.dbk:1186
msgid ""
"The extended description will complete the short description. It may refer "
"to the available choices. It may also mention that the user may choose more "
msgstr ""
#. type: Content of: <chapter><section><section><section><section><title>
-#: best-pkging-practices.dbk:1262
+#: best-pkging-practices.dbk:1196
msgid "Notes"
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*."
+#: best-pkging-practices.dbk:1200
+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>
-#: best-pkging-practices.dbk:1271
+#: best-pkging-practices.dbk:1205
msgid ""
"The extended description is what will be displayed as a more detailed "
"explanation of the note. Phrases, no terse writing style."
msgstr ""
#. type: Content of: <chapter><section><section><section><section><itemizedlist><listitem><para>
-#: best-pkging-practices.dbk:1277
+#: best-pkging-practices.dbk:1211
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>
-#: best-pkging-practices.dbk:1292
+#: best-pkging-practices.dbk:1226
msgid "Choices field"
msgstr ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:1294
+#: best-pkging-practices.dbk:1228
msgid ""
"If the Choices are likely to change often, please consider using the "
"__Choices trick. This will split each individual choice into a single "
msgstr ""
#. type: Content of: <chapter><section><section><section><title>
-#: best-pkging-practices.dbk:1301 best-pkging-practices.dbk:1339
+#: best-pkging-practices.dbk:1235 best-pkging-practices.dbk:1273
msgid "Default field"
msgstr ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:1303
+#: best-pkging-practices.dbk:1237
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>
-#: best-pkging-practices.dbk:1308
+#: best-pkging-practices.dbk:1242
msgid ""
"This special field allow translators to put the most appropriate choice "
"according to their own language. It will become the default choice when "
msgstr ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:1314
+#: best-pkging-practices.dbk:1248
msgid "Example, taken from the geneweb package templates:"
msgstr ""
#. type: Content of: <chapter><section><section><section><screen>
-#: best-pkging-practices.dbk:1317
+#: best-pkging-practices.dbk:1251
#, no-wrap
msgid ""
"Template: geneweb/lang\n"
"(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 ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:1328
+#: best-pkging-practices.dbk:1262
msgid ""
"Note the use of brackets which allow internal comments in debconf fields. "
"Also note the use of comments which will show up in files the translators "
msgstr ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:1333
+#: best-pkging-practices.dbk:1267
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 ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:1341
+#: best-pkging-practices.dbk:1275
msgid ""
"Do NOT use empty default field. If you don't want to use default values, do "
"not use Default at all."
msgstr ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:1345
+#: best-pkging-practices.dbk:1279
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>
-#: best-pkging-practices.dbk:1350
+#: best-pkging-practices.dbk:1284
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>
-#: best-pkging-practices.dbk:1362
+#: best-pkging-practices.dbk:1296
msgid "Internationalization"
msgstr ""
+#. type: Content of: <chapter><section><para>
+#: best-pkging-practices.dbk:1298
+msgid ""
+"This section contains global information for developers to make translators' "
+"life easier. More information for translators and developers interested 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:1364
+#: best-pkging-practices.dbk:1305
msgid "Handling debconf translations"
msgstr ""
#. type: Content of: <chapter><section><section><para>
-#: best-pkging-practices.dbk:1366
+#: best-pkging-practices.dbk:1307
msgid ""
"Like porters, translators have a difficult task. They work on many packages "
"and must collaborate with many different maintainers. Moreover, most of the "
msgstr ""
#. type: Content of: <chapter><section><section><para>
-#: best-pkging-practices.dbk:1372
+#: best-pkging-practices.dbk:1313
msgid ""
"The goal of <systemitem role=\"package\">debconf</systemitem> was to make "
"packages configuration easier for maintainers and for users. Originally, "
msgstr ""
#. type: Content of: <chapter><section><section><para>
-#: best-pkging-practices.dbk:1382
+#: best-pkging-practices.dbk:1323
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 "
msgstr ""
#. type: Content of: <chapter><section><section><title>
-#: best-pkging-practices.dbk:1398
+#: best-pkging-practices.dbk:1339
msgid "Internationalized documentation"
msgstr ""
#. type: Content of: <chapter><section><section><para>
-#: best-pkging-practices.dbk:1400
+#: best-pkging-practices.dbk:1341
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 "
msgstr ""
#. type: Content of: <chapter><section><section><para>
-#: best-pkging-practices.dbk:1405
+#: best-pkging-practices.dbk:1346
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:1360
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 "
"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:1366
+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:1378
msgid "Common packaging situations"
msgstr ""
#. type: Content of: <chapter><section><section><title>
-#: best-pkging-practices.dbk:1440
+#: best-pkging-practices.dbk:1389
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:1391
msgid ""
"Keeping <command>autoconf</command>'s <filename>config.sub</filename> and "
"<filename>config.guess</filename> files up to date is critical for porters, "
msgstr ""
#. type: Content of: <chapter><section><section><title>
-#: best-pkging-practices.dbk:1454
+#: best-pkging-practices.dbk:1403
msgid "Libraries"
msgstr ""
#. type: Content of: <chapter><section><section><para>
-#: best-pkging-practices.dbk:1456
+#: best-pkging-practices.dbk:1405
msgid ""
"Libraries are always difficult to package for various reasons. The policy "
"imposes many constraints to ease their maintenance and to make sure upgrades "
msgstr ""
#. type: Content of: <chapter><section><section><para>
-#: best-pkging-practices.dbk:1462
+#: best-pkging-practices.dbk:1411
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:1418
msgid "Documentation"
msgstr ""
#. type: Content of: <chapter><section><section><para>
-#: best-pkging-practices.dbk:1471
+#: best-pkging-practices.dbk:1420
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:1425
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 "
msgstr ""
#. type: Content of: <chapter><section><section><para>
-#: best-pkging-practices.dbk:1481
+#: best-pkging-practices.dbk:1430
msgid ""
"Policy specifies that documentation should be shipped in HTML format. We "
"also recommend shipping documentation in PDF and plain text format if "
msgstr ""
#. type: Content of: <chapter><section><section><para>
-#: best-pkging-practices.dbk:1488
+#: best-pkging-practices.dbk:1437
msgid ""
"Major shipped manuals should register themselves with <systemitem "
"role=\"package\">doc-base</systemitem> on installation. See the <systemitem "
msgstr ""
#. type: Content of: <chapter><section><section><para>
-#: best-pkging-practices.dbk:1494
+#: best-pkging-practices.dbk:1443
msgid ""
"Debian policy (section 12.1) directs that manual pages should accompany "
"every program, utility, and function, and suggests them for other objects "
msgstr ""
#. type: Content of: <chapter><section><section><para>
-#: best-pkging-practices.dbk:1501
+#: best-pkging-practices.dbk:1450
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:1459
msgid "Specific types of packages"
msgstr ""
#. type: Content of: <chapter><section><section><para>
-#: best-pkging-practices.dbk:1512
+#: best-pkging-practices.dbk:1461
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:1467
msgid ""
"Perl related packages have a <ulink url=\"&url-perl-policy;\">Perl "
"policy</ulink>, some examples of packages following that policy are "
msgstr ""
#. type: Content of: <chapter><section><section><itemizedlist><listitem><para>
-#: best-pkging-practices.dbk:1527
+#: best-pkging-practices.dbk:1476
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:1483
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:1490
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:1497
msgid ""
"Ocaml related packages have their own policy, found in &file-ocaml-policy; "
"from the <systemitem role=\"package\">ocaml</systemitem> package. A good "
msgstr ""
#. type: Content of: <chapter><section><section><itemizedlist><listitem><para>
-#: best-pkging-practices.dbk:1556
+#: best-pkging-practices.dbk:1505
msgid ""
"Packages providing XML or SGML DTDs should conform to the recommendations "
"found in the <systemitem role=\"package\">sgml-base-doc</systemitem> "
msgstr ""
#. type: Content of: <chapter><section><section><itemizedlist><listitem><para>
-#: best-pkging-practices.dbk:1562
+#: best-pkging-practices.dbk:1511
msgid ""
"Lisp packages should register themselves with <systemitem "
"role=\"package\">common-lisp-controller</systemitem>, about which see "
msgstr ""
#. type: Content of: <chapter><section><section><title>
-#: best-pkging-practices.dbk:1592
+#: best-pkging-practices.dbk:1541
msgid "Architecture-independent data"
msgstr ""
#. type: Content of: <chapter><section><section><para>
-#: best-pkging-practices.dbk:1594
+#: best-pkging-practices.dbk:1543
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, "
msgstr ""
#. type: Content of: <chapter><section><section><para>
-#: best-pkging-practices.dbk:1601
+#: best-pkging-practices.dbk:1550
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:1562
msgid "Needing a certain locale during build"
msgstr ""
#. type: Content of: <chapter><section><section><para>
-#: best-pkging-practices.dbk:1615
+#: best-pkging-practices.dbk:1564
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:1568
msgid ""
"If you set <varname>LOCPATH</varname> to the equivalent of "
"<filename>/usr/lib/locale</filename>, and <varname>LC_ALL</varname> to the "
msgstr ""
#. type: Content of: <chapter><section><section><screen>
-#: best-pkging-practices.dbk:1624
+#: best-pkging-practices.dbk:1573
#, no-wrap
msgid ""
"LOCALE_PATH=debian/tmpdir/usr/lib/locale\n"
msgstr ""
#. type: Content of: <chapter><section><section><title>
-#: best-pkging-practices.dbk:1637
+#: best-pkging-practices.dbk:1586
msgid "Make transition packages deborphan compliant"
msgstr ""
#. type: Content of: <chapter><section><section><para>
-#: best-pkging-practices.dbk:1639
+#: best-pkging-practices.dbk:1588
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 "
msgstr ""
#. type: Content of: <chapter><section><section><para>
-#: best-pkging-practices.dbk:1646
+#: best-pkging-practices.dbk:1595
msgid ""
"For example, with <literal>--guess-dummy</literal>, "
"<command>deborphan</command> tries to search all transitional packages which "
msgstr ""
#. type: Content of: <chapter><section><section><para>
-#: best-pkging-practices.dbk:1653
+#: best-pkging-practices.dbk:1602
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: "
"search .|grep transitional</command>."
msgstr ""
+#. type: Content of: <chapter><section><section><para>
+#: best-pkging-practices.dbk:1608
+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:1617
+msgid "Best practices for <filename>.orig.tar.{gz,bz2,xz}</filename> files"
msgstr ""
#. type: Content of: <chapter><section><section><para>
-#: best-pkging-practices.dbk:1663
+#: best-pkging-practices.dbk:1619
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:1623
msgid "Pristine source"
msgstr ""
#. type: Content of: <chapter><section><section><section><para><footnote><para>
-#: best-pkging-practices.dbk:1671
+#: best-pkging-practices.dbk:1627
msgid ""
"We cannot prevent upstream authors from changing the tarball they distribute "
"without also incrementing the version number, so there can be no guarantee "
"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,xz}</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:1625
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 "
-"t
arball officially distributed by the upstream author. <placeholder "
+"<filename>.orig.tar.{gz,bz2,xz}</filename> file is byte-for-byte identical "
+"t
o 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, "
msgstr ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:1689
+#: best-pkging-practices.dbk:1645
msgid ""
"There is no universally accepted guidelines that upstream authors follow "
"regarding to the directory structure inside their tarball, but "
msgstr ""
#. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
-#: best-pkging-practices.dbk:1697
+#: best-pkging-practices.dbk:1653
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:1656
#, 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:1661
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:1670
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:1681
msgid "Repackaged upstream source"
msgstr ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:1727
+#: best-pkging-practices.dbk:1683
msgid ""
"You <emphasis role=\"strong\">should</emphasis> upload packages with a "
"pristine source tarball if possible, but there are various reasons why it "
msgstr ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:1734
+#: best-pkging-practices.dbk:1690
msgid ""
"In these cases the developer must construct a suitable "
-"<literal>.orig.tar.{gz,bz2} </literal> file himself. We refer to such a "
+"<filename>.orig.tar.{gz,bz2,xz}</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,xz}</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:1699
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,xz}</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 "
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:1708
+msgid "A repackaged <filename>.orig.tar.{gz,bz2,xz}</filename>"
msgstr ""
#. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
-#: best-pkging-practices.dbk:1757
+#: best-pkging-practices.dbk:1713
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:1728
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:1726
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:1739
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:1748
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 "
msgstr ""
#. type: Content of: <chapter><section><section><section><orderedlist><listitem><para>
-#: best-pkging-practices.dbk:1799
+#: best-pkging-practices.dbk:1755
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:1763
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:1770
msgid "Changing binary files"
msgstr ""
#. type: Content of: <chapter><section><section><section><para>
-#: best-pkging-practices.dbk:1816
+#: best-pkging-practices.dbk:1772
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 "
msgstr ""
#. type: Content of: <chapter><section><section><title>
-#: best-pkging-practices.dbk:1831
+#: best-pkging-practices.dbk:1787
msgid "Best practices for debug packages"
msgstr ""
#. type: Content of: <chapter><section><section><para>
-#: best-pkging-practices.dbk:1833
+#: best-pkging-practices.dbk:1789
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:1797
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 "
msgstr ""
#. type: Content of: <chapter><section><section><para>
-#: best-pkging-practices.dbk:1851
+#: best-pkging-practices.dbk:1807
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 "
msgstr ""
#. type: Content of: <chapter><section><section><para>
-#: best-pkging-practices.dbk:1863
+#: best-pkging-practices.dbk:1819
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:1827
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:1834
msgid ""
"Note that the debug package should depend on the package that it provides "
"debugging symbols for, and this dependency should be versioned. For "
msgstr ""
#. type: Content of: <chapter><section><section><screen>
-#: best-pkging-practices.dbk:1882
+#: best-pkging-practices.dbk:1838
#, no-wrap
msgid "Depends: libfoo (= ${binary:Version})\n"
msgstr ""
+
+#. type: Content of: <chapter><section><section><title>
+#: best-pkging-practices.dbk:1842
+msgid "Best practices for meta-packages"
+msgstr ""
+
+#. type: Content of: <chapter><section><section><para>
+#: best-pkging-practices.dbk:1844
+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:1858
+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 ""
~ianmdlvl / developers-reference.git / blobdiff