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

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



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

This review will last from Tuesday, November 06, 2007 to Friday, November 16, 2007.

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:
--- ../smb2www.old/debian/templates	2007-10-29 11:37:20.087321267 +0100
+++ debian/templates	2007-11-02 13:18:36.234921940 +0100
@@ -1,28 +1,24 @@
 Template: smb2www/security
 Type: note
-_Description: smb2www is DISABLED by default
- If enabled, by default smb2www will allow anyone to browse your network.
+_Description: smb2www disabled by default
+ If enabled, smb2www will, by default, allow anyone to browse the network.

Do not make a sentence in the synopsis. Avoid shouting. This note is
invasive enough (and, imho, debconf abuse) and capital letters make it
even more invasive

s/your/the: it is not "my" network. Maybe use "the *local SMB* network"
which is indeed what will happen when enabling smb2www.

  .
- Probably this is not what you want to happen. Please modify your web
- server configuration to suit. Please read
- /usr/share/doc/smb2www/index.html for more information (Especially FAQ 4)
- on how to do this for Apache.
+ As this may have security consequences, it is disabled by default and you
+ should modify the web
+ server configuration to enable smb2www securely. Please read
+ /usr/share/doc/smb2www/index.html for more information (more particularly FAQ 4)
+ about such configuration for Apache.

Avoid "spoken" language and ue a more neutral wording. "to suit" had
no meaning for me and I changed this to "to enable smb2www securely"

I replaced "Especially" but I'm not entirely sure about this. Justin
will probably comment and propose something better..:)
 
 Template: smb2www/set_link
 Type: boolean
 Default: false
 _Description: Do you want to enable smb2www?
- Turn this option on if you want to enable smb2www.
- .
- Note that you can enable smb2www at any time by running
-   dpkg-reconfigure smb2www
- command.

The long description here is either repeating the question.....or
explaining obvious things (run "dpkg-reconfigure" to reconfigure
software). Just drop it.

We could be more invasive and merge these two templates in one that
explains why smb2www is disabled by default and gives the option to
enable it.

 
 Template: smb2www/master_browser
 Type: string
 Default: localhost
 _Description: Master browser server:
- Please enter name of the server which will be used by smb2www as a master
+ Please enter the name of the server which will be used by smb2www as a master
  browser.

Missing article
 
 Template: smb2www/language
@@ -34,10 +30,10 @@
 #  them, and have to simply choose a msgstr among the English values
 #  listed in the Choices field above, e.g. msgstr "Dutch"
 _Default: English[ default language ]
-_Description: Language in which smb2www will generate its pages:
+_Description: Language for smb2www pages:
  Smb2www can generate its HTML pages in several languages.


Simpler sentence

  .
- Please choose one of them.
+ Please choose the language you want to use on generated pages.

Another option: drop the first paragraph-->if we give users the
opportunity to choose among languages, this is because smb2www
supports more than one..:-)

 
 Template: smb2www/need_reconfigure
 Type: boolean
@@ -49,23 +45,22 @@
 Template: smb2www/replace_config
 Type: boolean
 Default: true
-_Description: Do you want to install new version of config file?
- Current smb2www configuration file `/etc/smb2www/smb2www.conf' contains
- some variables (e.g. `bindir'), which sometimes needs to be changed on
- package upgrade, and some variables (like `masterbrowser'), which
+_Description: Install a new version of the configuration file?

Missing articles

+ The current smb2www configuration file `/etc/smb2www/smb2www.conf' contains
+ some variables (such as 'bindir'), which sometimes needs to be changed on
+ package upgrade, and some others (such as 'masterbrowser'), which
  shouldn't.

Missing articles. s/like/such as


  .
- It's very hard to maintain such file, so for better management of smb2www
- upgrades,
- the file has been split into two files:
- `/usr/share/smb2www/smb2www.default' and `/etc/smb2www/smb2www.conf'. The
- former will be overwritten on each upgrade, the latter - will not.
+ For better management of this configuration file, it
+ has been split in two parts:
+ /usr/share/smb2www/smb2www.default and /etc/smb2www/smb2www.conf. The
+ former will be overwritten on each upgrade whilethe latter remains unchanged.
  Variables defined in the latter file will override variables defined in
  the former.

Neutral wording rather than spoken language ("it is very hard").

  .
- Your current smb2www config file will be saved as
-  `/etc/smb2www/smb2www.conf.saved_by_postinst'
+ The current smb2www config file will be saved as
+  '/etc/smb2www/smb2www.conf.saved_by_postinst'

Unpersonnalize

  .
- If you don't choose this option, smb2www probably will not work. In that case please
- compare your config file with `/usr/share/smb2www/smb2www.default', and
+ If you don't choose this option, smb2www will probably not work. You should
+ compare the configuration file with `/usr/share/smb2www/smb2www.default', and
  adjust it as needed.
--- ../smb2www.old/debian/control	2007-10-29 11:37:20.087321267 +0100
+++ debian/control	2007-11-02 13:20:12.729997417 +0100
@@ -8,6 +8,7 @@
 Package: smb2www
 Architecture: all
 Depends: smbclient, ${perl:Depends}, ${misc:Depends}, apache2|httpd-cgi
-Description: A Windows Network client that is accessible through a web browser
- With this package you will be able to browse a Windows Network using a 
- standard web browser.  It is based upon the samba package.
+Description: SMB/CIFS network client with a web interface

drop leading article

technically speaking, this is about browsing a SMB network. This often
reduces to a Windows network, but of course not only.

Avoid a sentence by using "with a web interface"


+ This package allows browsing a SMB/CIFS-based network (such as 
+ a Windows-based network by using a 
+ standard web browser. It uses Samba libraries.

Neutral wording. And, here, explain that most SMB networks are
Windows-based networks.

If I'm correct, smb2www is not based on samba but uses its libraries.


-- 


Template: smb2www/security
Type: note
_Description: smb2www disabled by default
 If enabled, smb2www will, by default, allow anyone to browse the network.
 .
 As this may have security consequences, it is disabled by default and you
 should modify the web
 server configuration to enable smb2www securely. Please read
 /usr/share/doc/smb2www/index.html for more information (more particularly FAQ 4)
 about such configuration for Apache.

Template: smb2www/set_link
Type: boolean
Default: false
_Description: Do you want to enable smb2www?

Template: smb2www/master_browser
Type: string
Default: localhost
_Description: Master browser server:
 Please enter the name of the server which will be used by smb2www as a master
 browser.

Template: smb2www/language
Type: select
__Choices: English, Czech, Dutch, Finnish, French, Polish, Spanish, Swedish, Vietnamese
#  You must NOT translate this string, but you can change its value.
#  The comment between brackets is used to distinguish this msgid
#  from the one in the Choices list; you do not have to worry about
#  them, and have to simply choose a msgstr among the English values
#  listed in the Choices field above, e.g. msgstr "Dutch"
_Default: English[ default language ]
_Description: Language for smb2www pages:
 Smb2www can generate its HTML pages in several languages.
 .
 Please choose the language you want to use on generated pages.

Template: smb2www/need_reconfigure
Type: boolean
Default: false
Description: for internal use
 This is an INTERNAL option. If you see it while configuring the package,
 please file a bug report against smb2www.

Template: smb2www/replace_config
Type: boolean
Default: true
_Description: Install a new version of the configuration file?
 The current smb2www configuration file `/etc/smb2www/smb2www.conf' contains
 some variables (such as 'bindir'), which sometimes needs to be changed on
 package upgrade, and some others (such as 'masterbrowser'), which
 shouldn't.
 .
 For better management of this configuration file, it
 has been split in two parts:
 /usr/share/smb2www/smb2www.default and /etc/smb2www/smb2www.conf. The
 former will be overwritten on each upgrade whilethe latter remains unchanged.
 Variables defined in the latter file will override variables defined in
 the former.
 .
 The current smb2www config file will be saved as
  '/etc/smb2www/smb2www.conf.saved_by_postinst'
 .
 If you don't choose this option, smb2www will probably not work. You should
 compare the configuration file with `/usr/share/smb2www/smb2www.default', and
 adjust it as needed.
--- ../smb2www.old/debian/templates	2007-10-29 11:37:20.087321267 +0100
+++ debian/templates	2007-11-02 13:18:36.234921940 +0100
@@ -1,28 +1,24 @@
 Template: smb2www/security
 Type: note
-_Description: smb2www is DISABLED by default
- If enabled, by default smb2www will allow anyone to browse your network.
+_Description: smb2www disabled by default
+ If enabled, smb2www will, by default, allow anyone to browse the network.
  .
- Probably this is not what you want to happen. Please modify your web
- server configuration to suit. Please read
- /usr/share/doc/smb2www/index.html for more information (Especially FAQ 4)
- on how to do this for Apache.
+ As this may have security consequences, it is disabled by default and you
+ should modify the web
+ server configuration to enable smb2www securely. Please read
+ /usr/share/doc/smb2www/index.html for more information (more particularly FAQ 4)
+ about such configuration for Apache.
 
 Template: smb2www/set_link
 Type: boolean
 Default: false
 _Description: Do you want to enable smb2www?
- Turn this option on if you want to enable smb2www.
- .
- Note that you can enable smb2www at any time by running
-   dpkg-reconfigure smb2www
- command.
 
 Template: smb2www/master_browser
 Type: string
 Default: localhost
 _Description: Master browser server:
- Please enter name of the server which will be used by smb2www as a master
+ Please enter the name of the server which will be used by smb2www as a master
  browser.
 
 Template: smb2www/language
@@ -34,10 +30,10 @@
 #  them, and have to simply choose a msgstr among the English values
 #  listed in the Choices field above, e.g. msgstr "Dutch"
 _Default: English[ default language ]
-_Description: Language in which smb2www will generate its pages:
+_Description: Language for smb2www pages:
  Smb2www can generate its HTML pages in several languages.
  .
- Please choose one of them.
+ Please choose the language you want to use on generated pages.
 
 Template: smb2www/need_reconfigure
 Type: boolean
@@ -49,23 +45,22 @@
 Template: smb2www/replace_config
 Type: boolean
 Default: true
-_Description: Do you want to install new version of config file?
- Current smb2www configuration file `/etc/smb2www/smb2www.conf' contains
- some variables (e.g. `bindir'), which sometimes needs to be changed on
- package upgrade, and some variables (like `masterbrowser'), which
+_Description: Install a new version of the configuration file?
+ The current smb2www configuration file `/etc/smb2www/smb2www.conf' contains
+ some variables (such as 'bindir'), which sometimes needs to be changed on
+ package upgrade, and some others (such as 'masterbrowser'), which
  shouldn't.
  .
- It's very hard to maintain such file, so for better management of smb2www
- upgrades,
- the file has been split into two files:
- `/usr/share/smb2www/smb2www.default' and `/etc/smb2www/smb2www.conf'. The
- former will be overwritten on each upgrade, the latter - will not.
+ For better management of this configuration file, it
+ has been split in two parts:
+ /usr/share/smb2www/smb2www.default and /etc/smb2www/smb2www.conf. The
+ former will be overwritten on each upgrade whilethe latter remains unchanged.
  Variables defined in the latter file will override variables defined in
  the former.
  .
- Your current smb2www config file will be saved as
-  `/etc/smb2www/smb2www.conf.saved_by_postinst'
+ The current smb2www config file will be saved as
+  '/etc/smb2www/smb2www.conf.saved_by_postinst'
  .
- If you don't choose this option, smb2www probably will not work. In that case please
- compare your config file with `/usr/share/smb2www/smb2www.default', and
+ If you don't choose this option, smb2www will probably not work. You should
+ compare your configuration file with `/usr/share/smb2www/smb2www.default', and
  adjust it as needed.
--- ../smb2www.old/debian/control	2007-10-29 11:37:20.087321267 +0100
+++ debian/control	2007-11-02 13:20:12.729997417 +0100
@@ -8,6 +8,7 @@
 Package: smb2www
 Architecture: all
 Depends: smbclient, ${perl:Depends}, ${misc:Depends}, apache2|httpd-cgi
-Description: A Windows Network client that is accessible through a web browser
- With this package you will be able to browse a Windows Network using a 
- standard web browser.  It is based upon the samba package.
+Description: SMB/CIFS network client with a web interface
+ This package allows browsing a SMB/CIFS-based network (such as 
+ a Windows-based network by using a 
+ standard web browser. It uses Samba libraries.
Source: smb2www
Section: net
Priority: optional
Maintainer: Robert Luberda <robert@debian.org>
Standards-Version: 3.7.2
Build-Depends: debhelper (>= 5.0.57), po4a (>= 0.22)

Package: smb2www
Architecture: all
Depends: smbclient, ${perl:Depends}, ${misc:Depends}, apache2|httpd-cgi
Description: SMB/CIFS network client with a web interface
 This package allows browsing a SMB/CIFS-based network (such as 
 a Windows-based network by using a 
 standard web browser. It uses Samba libraries.

Attachment: signature.asc
Description: Digital signature


Reply to: