[Po4a-commits] "po-debconf/doc/en po-debconf.7.pod,1.8,1.9"

[Nicolas FRANCOIS]

Update of /cvsroot/po4a/po-debconf/doc/en
In directory alioth:/tmp/cvs-serv29928/doc/en

Modified Files:
	po-debconf.7.pod 
Log Message:
  * doc/en/po-debconf.7.pod: document the debugging process. Thanks to James
    R. Van Zandt. Closes: #505393


Index: po-debconf.7.pod
===================================================================
RCS file: /cvsroot/po4a/po-debconf/doc/en/po-debconf.7.pod,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -d -r1.8 -r1.9
--- po-debconf.7.pod	5 Apr 2009 12:31:38 -0000	1.8
+++ po-debconf.7.pod	5 Apr 2009 12:55:43 -0000	1.9
@@ -8,7 +8,7 @@
 The goal of C<debconf> was to make package configuration user-friendly.  In
 order to achieve this, it is important to ensure that users will get the
 question in their own language.  Translators need a framework to easily
-work on translations without having to track down package development;
+work on translations without having to track package development;
 C<po-debconf> was designed to be able to work with standard C<gettext>
 tools when translating debconf templates files.
 
@@ -29,7 +29,7 @@
 
 Paths are relative to the parent directory.
 
-=item - Prepend an underscore before translatable fields
+=item - Prepend an underscore before translatable fields in each template
 
 Normally C<Description>, C<Choices> and sometimes C<Default> fields can be translated.
 
@@ -45,7 +45,7 @@
 =head1 UPDATE TEMPLATES
 
 In order to help translators, PO files in your package should always
-be up-to-date, otherwise they may lose their time with unused strings.
+be up-to-date, otherwise they may waste their time translating unused strings.
 For that, simply call the following command without arguments:
 
   $ debconf-updatepo
@@ -60,7 +60,7 @@
 files are fully translated.
 
 The B<debconf-updatepo> program is idempotent, it modifies PO files only
-if their content has been updated.  Thus the best solution to provide
+if their content has been updated.  Thus the best way to provide
 up-to-date PO files in your source package is to call this command from
 the C<clean> target of the F<debian/rules> file.
 
@@ -128,7 +128,7 @@
 =head2 SPLITTING CHOICES LIST
 
 Since C<po-debconf> 0.6.0, localized fields may contain two leading
-underscores.  In this case, field value is supposed to be a comma
+underscores.  In this case, the field value is supposed to be a comma
 separated list of values, which are put in separate msgids.  Thus
 if the previous example did contain
 
@@ -166,15 +166,15 @@
 Eventually you have to remove F<foo> and manually edit F<debian/templates> to
 replace C<_Choices> by C<__Choices> before B<debconf-updatepo> is run.
 
-=head2 PUTTING COMMENTS FOR TRANSLATORS
+=head2 PUTTING IN COMMENTS FOR TRANSLATORS
 
 C<Dpkg> maintainers decided that by convention lines beginning with
 a number sign (C<#>) are comments in F<debian/control> files, and C<po-debconf>
 follows this rule.  Since C<po-debconf> 0.8.0, such comments are written
-into PO files, and can then contain valuable informations for
+into PO files, and can then contain valuable information for
 translators.  Incidentally all previous C<po-debconf> versions ignore
 lines which do not contain a colon, thus if your comments does not
-contain any colon, there is no need to add a versioned build dependency
+contain any colons, there is no need to add a versioned build dependency
 against C<po-debconf>.  Here is an example:
 
   Template: debconf/button-yes
@@ -282,6 +282,23 @@
 for instance one week in advance.  A dedicated tool, B<podebconf-report-po>,
 has been written for this purpose.  Do not hesitate to abuse it!
 
+=head1 DEBUGGING
+
+You will find that B<debconf-loadtemplate> will not accept a templates
+file with i18n markups.  However, it will accept a merged file, so if
+you have been debugging your debconf setup like this
+
+  rm /tmp/{config,templates}.dat{,-old}
+  debconf-loadtemplate debian/templates
+  DEBIAN_PRIORITY=low debconf -freadline debian/config configure 28.0
+
+you will now need something like this instead:
+
+  po2debconf debian/templates > debian/tmp/DEBIAN/templates
+  rm /tmp/{config,templates}.dat{,-old}
+  debconf-loadtemplate debian/tmp/DEBIAN/templates
+  DEBIAN_PRIORITY=low debconf -freadline debian/config configure 28.0
+
 =head1 CAVEATS
 
 =over 2
@@ -296,7 +313,7 @@
 
 =item *
 
-A given English string may have only one unique translation in a given
+A given English string may be given only one unique translation in a given
 language.  It is impossible to give two different translations, depending
 on the context.  To solve this issue, you have to add special markups to
 the different occurrences of a given string to make them different.
@@ -405,8 +422,9 @@
 L<debconf-gettextize(1)>,
 L<debconf-updatepo(1)>,
 L<dh_installdebconf(1)>,
-L<podebconf-report-po(1)>.
-L<po2debconf(1)>.
+L<podebconf-report-po(1)>,
+L<po2debconf(1)>,
+L<debconf-devel(7)>.
 
 =head1 AUTHORS