[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: New debconf templates for apt-listchanges



Robert Luberda wrote:
> I added four new debconf templates for apt-listchanges a week ago.
> Could you please review them and make suggestions how to improve them?
> 
> 
> Template: apt-listchanges/email-format
> Type: select
> __Choices: text, html

If "text" and "html" are strings that need to end up in a config-file
verbatim then this shouldn't be marked as localisable (with leading
underscores).  On the other hand, if they're English text it should be
"HTML".

> Default: text
> _Description: Format of e-mail messages:

Normally I would prefer "email", but for consistency with other
apt-listchanges messages we should leave the hyphen in.

>  Please choose a format of e-mail copies of the displayed changes.

That would be easier to follow as "format for e-mail copies".

>  .
>   text      : plain text message;
>   html      : html data with clickable links.

English punctuation doesn't allow spaces before a colon.  You can get
away with it if it's
   first      : foo
   twelfth    : bar
   ninetysixth: baz
   last:      : quux
with something "pushing" the column of colons into position, but here
it has no real excuse for being spaced at all.  And I'm not keen on
two-item lists - once it gets this short it really might as well just
be a sentence (which also avoids mixing translatable and verbatim
strings).

  Template: apt-listchanges/email-format
  Type: select
  Choices: text, html
  Default: text
  _Description: Format of e-mail messages:
   Please choose a format for e-mail copies of the displayed changes -
   either plain text or HTML with clickable links.
 
> Template: apt-listchanges/headers
> Type: boolean
> Default: false
> _Description: Should apt-listchanges insert headers before changelogs?

You can drop "Should apt-listchanges" here:

  _Description: Insert headers before changelogs?

>  apt-listchanges can insert a header before each package's changelog
>  showing the name of the package, and the names of the binary packages
>  which are being upgraded (when different from the source package name).
>  .
>  Note however that displaying headers might make the output a bit harder
>  to read as they might contain long lists of names of binary packages.

No problems here.
 
> Template: apt-listchanges/no-network
> Type: boolean
> Default: false
> _Description: Disable retrieving changes over network?
>  In rare cases when a binary package does not contain changelog file,
>  apt-listchanges by default executes 'apt-get changelog' command
>  that tries to download changelog entries from network.

Some missing articles and so on:

   In rare cases when a binary package does not contain a changelog file,
   apt-listchanges by default executes the command "apt-get changelog",
   which tries to download changelog entries from the network.

>  .
>  This behavior can be disabled with this option what might be useful
>  for example for systems with limited network connectivity.

More English tweaks:

   This option can disable this behavior, which might for example be
   useful for systems with limited network connectivity.
 
> Template: apt-listchanges/reverse
> Type: boolean
> Default: false
> _Description: Show changes in the reverse order?

For some reason we say this one *without* an article:

  _Description: Show changes in reverse order?

>  By default apt-listchanges shows changes for each package in the order
>  of their appearance in the relevant changelog or news files - from the
>  most recent version of the package to the most oldest one.

We do say "most senior", but we don't say "most oldest"!

   most recent version of the package to the oldest.

>  .
>  Optionally apt-listchanges can display changes in the opposite order,
>  that some people might find more natural: from the oldest changes in
>  the package to the newest ones.

   Optionally apt-listchanges can display changes in the opposite order,
   which some may find more natural: from the oldest changes in the
   package to the newest.

-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
--- template	2017-07-17 21:31:10.190722888 +0100
+++ template.jbr	2017-07-17 21:31:41.921799550 +0100
@@ -1,18 +1,15 @@
 Template: apt-listchanges/email-format
 Type: select
-__Choices: text, html
+Choices: text, html
 Default: text
 _Description: Format of e-mail messages:
- Please choose a format of e-mail copies of the displayed changes.
- .
-  text      : plain text message;
-  html      : html data with clickable links.
-
+ Please choose a format for e-mail copies of the displayed changes -
+ either plain text or HTML with clickable links.
 
 Template: apt-listchanges/headers
 Type: boolean
 Default: false
-_Description: Should apt-listchanges insert headers before changelogs?
+_Description: Insert headers before changelogs?
  apt-listchanges can insert a header before each package's changelog
  showing the name of the package, and the names of the binary packages
  which are being upgraded (when different from the source package name).
@@ -20,27 +17,25 @@
  Note however that displaying headers might make the output a bit harder
  to read as they might contain long lists of names of binary packages.
 
-
 Template: apt-listchanges/no-network
 Type: boolean
 Default: false
 _Description: Disable retrieving changes over network?
- In rare cases when a binary package does not contain changelog file,
- apt-listchanges by default executes 'apt-get changelog' command
- that tries to download changelog entries from network.
+ In rare cases when a binary package does not contain a changelog file,
+ apt-listchanges by default executes the command "apt-get changelog",
+ which tries to download changelog entries from the network.
  .
- This behavior can be disabled with this option what might be useful
- for example for systems with limited network connectivity.
-
+ This option can disable this behavior, which might for example be
+ useful for systems with limited network connectivity.
 
 Template: apt-listchanges/reverse
 Type: boolean
 Default: false
-_Description: Show changes in the reverse order?
+_Description: Show changes in reverse order?
  By default apt-listchanges shows changes for each package in the order
  of their appearance in the relevant changelog or news files - from the
- most recent version of the package to the most oldest one.
+ most recent version of the package to the oldest.
  .
  Optionally apt-listchanges can display changes in the opposite order,
- that some people might find more natural: from the oldest changes in
- the package to the newest ones.
+ which some may find more natural: from the oldest changes in the
+ package to the newest.

Reply to: