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

[RFR] templates://leafnode/{templates}



Please find, for review, the debconf templates and packages descriptions for the leafnode source package.

This review will last from Saturday, February 02, 2008 to Tuesday, February 12, 2008.

Please send reviews as unified diffs (diff -u) against the original
files. Comments about your proposed changes will be appreciated.

Your review should be sent as an answer to this mail.

When appropriate, I will send intermediate requests for review, with
"[RFRn]" (n>=2) as a subject tag.

When we will reach a consensus, I send a "Last Chance For
Comments" mail with "[LCFC]" as a subject tag.

Finally, the reviewed templates will be sent to the package maintainer
as a bug report, and a mail will be sent to this list with "[BTS]" as
a subject tag.

Rationale:
--- ../leafnode.old/debian/templates	2008-01-27 07:55:57.356845848 +0100
+++ debian/templates	2008-02-02 07:38:18.539486613 +0100
@@ -1,57 +1,62 @@
 Template: leafnode/server
 Type: string
-_Default: news
+Default: news

Not really translatable

 _Description: Server to download news from:
- Whoever is providing you with internet access should provide information about
- which server to use to download news. Typically this server is called
- something like "news.domain" or "nntp.domain".
+ The name of the news server should be provided by your Internet
+ service provider or your organization.
+ .
+ This server is generally called "news.<domain>" or "nntp.<domain>"
+ where <domain> is the local domain name.

I suggest a more neutral wording instead of the "Whoever" which was
sounding strange to me

 
 Template: leafnode/tcpd
 Type: boolean
 Default: true
 _Description: Enable access controls for Leafnode?
- If you do not enable some access controls for leafnode, people everywhere
- will be able to use your news server for things like posting spam or
- accessing huge binary newsgroups. People actively scan the net for open
- news servers.
- .
- If you do enable access controls, this will prevent any computers except
- localhost from accessing your news server. You can modify /etc/hosts.allow
- later to broaden the access controls if necessary.
+ If you do not enable some access controls for Leafnode, anybody
+ will be able to use the news server which opens opportunities
+ for spam or resource abuse.

Capitalize the program name.

s/people everywhere/anybody

s/your news/the news (unpersonnalization)

+ .
+ Access control will prevent any computers except
+ the news server itself to access newsgroups data. Later modifications of
+ /etc/hosts.allow may broaden this restriction to other machines if
+ necessary.
 
Again, slightly mor eneutral wording. May be enhanced, however....

 Template: leafnode/network
 Type: select
-_Choices: PPP, permanent, none
+#flag:translate!:1
+__Choices: PPP, permanent, none

Split out choices and unmark "PPP" which is not translatable

 Default: PPP
-_Description: What type of network connection do you have?
- The Leafnode package can automatically download new news for you.  When
- this should be done depends on your network connection.  The scripts
- provided with the package support two kinds of network connection: a
- permanent one and one provided by PPP.  When set up for PPP the package
- will download news every time a PPP connection is established.  With a
- permanent connection news will be downloaded every hour.  Either option
- will work if you are using diald to manage a PPP connection.
+_Description: Network connection type:

Drop interrogative form (lintian warns about this)

+ The Leafnode package can automatically download news.
+ .
+ The method used for this depends on the network connection type.
+ Scripts provided with the package support two network connection types:
+  - permanent: news are downloaded hourly;
+  - PPP      : news are downloaded every time a PPP connection is
+               established.
+ .
+ Either option will work if you are using diald to manage a PPP connection.

Split out paragraphs and use enumeration as an attempt to make the text easier to read.

Drop "for you" (unpersonnalization)

  .
- You can also select "none", which will disable automatic downloads. News
- can be downloaded manually by running fetchnews.
+ Choosing 'none' will disable automatic news downloads. News
+ can be downloaded manually by running 'fetchnews'.

quote the program name and small unpersonnalization.
 
 Template: leafnode/update-groups
 Type: boolean
 Default: true
-_Description: Do you wish to update the list of available groups?
- Leafnode keeps the list of available newsgroups up to date when
- it checks for new news.  Until it has done so it will not offer any
- newsgroups to clients.
+_Description: Update the list of available groups?

Shorten the question and make it more direct


+ Leafnode updates the list of available newsgroups when
+ it checks for new news. No newsgroups will be available until this has
+ happened at least once.

My use of tenses is probably wrong (Frenglish). Please correct /me if needed.

  .
- If you choose to update the list of groups during package set up then
+ If you choose to update the list of groups,
  newsgroups will be available to clients as soon as Leafnode has been
  set up.

"during package set up" seems obvious
 
 Template: leafnode/purge
 Type: boolean
 Default: false
-_Description: Should /var/spool/news and all its contents be removed?
- /var/spool/news holds the database of news articles downloaded by
- Leafnode.  Many other news servers also use this directory to store their
- news database - if you have replaced Leafnode with another server it is
- very likely that you do not want to do this.
+_Description: Remove news groups and articles when purging the package?
+ The /var/spool/news directory holds the database of news articles
+ downloaded by Leafnode. Many other news servers also use this
+ directory to store their news database and you may wish to keep it
+ even when removing the leafnode package.

Make the quesiton clearer about consequences. Removing the directory
removes the articles and groups.

Avoid startig a paragraph with a directory name

Keeping the directory may be needed even if one does not replace
leafnode with another news server, but for other purposes


--- ../leafnode.old/debian/control	2008-01-27 07:55:57.116823968 +0100
+++ debian/control	2008-02-02 07:39:19.071488041 +0100
@@ -11,9 +11,9 @@
 Conflicts: news-transport-system, newsx
 Depends: openbsd-inetd | inet-superserver, tcpd, logrotate, debconf (>= 0.5) | debconf-2.0, ${shlibs:Depends}
 Suggests: slrn | news-reader, perl5, libnet-perl
-Description: NNTP server for small leaf sites
+Description: NNTP server for small sites

I suggest moving "leaf" to the long description. May be disturbing for
non technical users.

  Leafnode is a news server suitable for small, limited-bandwidth sites 
- with only a few users. Leafnode keeps track of which groups are being
+ with only a few users ('leaf' sites). It keeps track of which groups are being
  read, and downloads only articles in those groups. Leafnode has been
  designed to require no maintenance and to be easy to set up.
  .



-- 


Template: leafnode/server
Type: string
Default: news
_Description: Server to download news from:
 The name of the news server should be provided by your Internet
 service provider or your organization.
 .
 This server is generally called "news.<domain>" or "nntp.<domain>"
 where <domain> is the local domain name.

Template: leafnode/tcpd
Type: boolean
Default: true
_Description: Enable access controls for Leafnode?
 If you do not enable some access controls for Leafnode, anybody
 will be able to use the news server which opens opportunities
 for spam or resource abuse.
 .
 Access control will prevent any computers except
 the news server itself to access newsgroups data. Later modifications of
 /etc/hosts.allow may broaden this restriction to other machines if
 necessary.

Template: leafnode/network
Type: select
#flag:translate!:1
__Choices: PPP, permanent, none
Default: PPP
_Description: Network connection type:
 The Leafnode package can automatically download news.
 .
 The method used for this depends on the network connection type.
 Scripts provided with the package support two network connection types:
  - permanent: news are downloaded hourly;
  - PPP      : news are downloaded every time a PPP connection is
               established.
 .
 Either option will work if you are using diald to manage a PPP connection.
 .
 Choosing 'none' will disable automatic news downloads. News
 can be downloaded manually by running 'fetchnews'.

Template: leafnode/update-groups
Type: boolean
Default: true
_Description: Update the list of available groups?
 Leafnode updates the list of available newsgroups when
 it checks for new news. No newsgroups will be available until this has
 happened at least once.
 .
 If you choose to update the list of groups,
 newsgroups will be available to clients as soon as Leafnode has been
 set up.

Template: leafnode/purge
Type: boolean
Default: false
_Description: Remove news groups and articles when purging the package?
 The /var/spool/news directory holds the database of news articles
 downloaded by Leafnode. Many other news servers also use this
 directory to store their news database and you may wish to keep it
 even when removing the leafnode package.
--- leafnode.old/debian/templates	2008-01-27 07:55:57.356845848 +0100
+++ leafnode/debian/templates	2008-02-02 18:31:47.431965786 +0100
@@ -1,57 +1,62 @@
 Template: leafnode/server
 Type: string
-_Default: news
+Default: news
 _Description: Server to download news from:
- Whoever is providing you with internet access should provide information about
- which server to use to download news. Typically this server is called
- something like "news.domain" or "nntp.domain".
+ The name of the news server should be provided by your Internet
+ service provider or your organization.
+ .
+ This server is generally called "news.<domain>" or "nntp.<domain>"
+ where <domain> is the local domain name.
 
 Template: leafnode/tcpd
 Type: boolean
 Default: true
 _Description: Enable access controls for Leafnode?
- If you do not enable some access controls for leafnode, people everywhere
- will be able to use your news server for things like posting spam or
- accessing huge binary newsgroups. People actively scan the net for open
- news servers.
- .
- If you do enable access controls, this will prevent any computers except
- localhost from accessing your news server. You can modify /etc/hosts.allow
- later to broaden the access controls if necessary.
+ If you do not enable some access controls for Leafnode, anybody
+ will be able to use the news server which opens opportunities
+ for spam or resource abuse.
+ .
+ Access control will prevent any computers except
+ the news server itself to access newsgroups data. Later modifications of
+ /etc/hosts.allow may broaden this restriction to other machines if
+ necessary.
 
 Template: leafnode/network
 Type: select
-_Choices: PPP, permanent, none
+#flag:translate!:1
+__Choices: PPP, permanent, none
 Default: PPP
-_Description: What type of network connection do you have?
- The Leafnode package can automatically download new news for you.  When
- this should be done depends on your network connection.  The scripts
- provided with the package support two kinds of network connection: a
- permanent one and one provided by PPP.  When set up for PPP the package
- will download news every time a PPP connection is established.  With a
- permanent connection news will be downloaded every hour.  Either option
- will work if you are using diald to manage a PPP connection.
+_Description: Network connection type:
+ The Leafnode package can automatically download news.
+ .
+ The method used for this depends on the type of network connection.
+ Scripts provided with the package support two network connection types:
+  - permanent: news are downloaded hourly;
+  - PPP      : news are downloaded every time a PPP connection is
+               established.
+ .
+ Either option will work if you are using diald to manage a PPP connection.
  .
- You can also select "none", which will disable automatic downloads. News
- can be downloaded manually by running fetchnews.
+ Choosing 'none' will disable automatic news downloads. News
+ can be downloaded manually by running 'fetchnews'.
 
 Template: leafnode/update-groups
 Type: boolean
 Default: true
-_Description: Do you wish to update the list of available groups?
- Leafnode keeps the list of available newsgroups up to date when
- it checks for new news.  Until it has done so it will not offer any
- newsgroups to clients.
+_Description: Update the list of available groups?
+ Leafnode updates the list of available newsgroups when
+ it checks for new news. No newsgroups will be available until this has
+ happened at least once.
  .
- If you choose to update the list of groups during package set up then
+ If you choose to update the list of groups,
  newsgroups will be available to clients as soon as Leafnode has been
  set up.
 
 Template: leafnode/purge
 Type: boolean
 Default: false
-_Description: Should /var/spool/news and all its contents be removed?
- /var/spool/news holds the database of news articles downloaded by
- Leafnode.  Many other news servers also use this directory to store their
- news database - if you have replaced Leafnode with another server it is
- very likely that you do not want to do this.
+_Description: Remove news groups and articles when purging the package?
+ The /var/spool/news directory holds the database of news articles
+ downloaded by Leafnode. Many other news servers also use this
+ directory to store their news database and you may wish to keep it
+ even when removing the leafnode package.
--- leafnode.old/debian/control	2008-01-27 07:55:57.116823968 +0100
+++ leafnode/debian/control	2008-02-02 07:39:19.071488041 +0100
@@ -11,9 +11,9 @@
 Conflicts: news-transport-system, newsx
 Depends: openbsd-inetd | inet-superserver, tcpd, logrotate, debconf (>= 0.5) | debconf-2.0, ${shlibs:Depends}
 Suggests: slrn | news-reader, perl5, libnet-perl
-Description: NNTP server for small leaf sites
+Description: NNTP server for small sites
  Leafnode is a news server suitable for small, limited-bandwidth sites 
- with only a few users. Leafnode keeps track of which groups are being
+ with only a few users ('leaf' sites). It keeps track of which groups are being
  read, and downloads only articles in those groups. Leafnode has been
  designed to require no maintenance and to be easy to set up.
  .
Source: leafnode
Section: news
Priority: extra
Maintainer: Mark Brown <broonie@debian.org>
Standards-Version: 3.7.3
Build-Depends: libpcre3-dev, debhelper (>= 6.0.0)

Package: leafnode
Architecture: any
Provides: news-transport-system
Conflicts: news-transport-system, newsx
Depends: openbsd-inetd | inet-superserver, tcpd, logrotate, debconf (>= 0.5) | debconf-2.0, ${shlibs:Depends}
Suggests: slrn | news-reader, perl5, libnet-perl
Description: NNTP server for small sites
 Leafnode is a news server suitable for small, limited-bandwidth sites 
 with only a few users ('leaf' sites). It keeps track of which groups are being
 read, and downloads only articles in those groups. Leafnode has been
 designed to require no maintenance and to be easy to set up.
 .
 Perl and the libnet-perl package are required to use some optional
 features of the package for handling very low volume newsgroups.

Attachment: signature.asc
Description: Digital signature


Reply to: