Please find, for review, the debconf templates and packages descriptions for the ipplan source package.
This review will last from Thursday, November 22, 2007 to Sunday, December 02, 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:
--- ../ipplan.old/debian/templates 2007-11-16 07:12:27.034275579 +0000
+++ debian/templates 2007-11-22 06:02:16.333928209 +0000
@@ -1,17 +1,16 @@
Template: ipplan/webserver_type
Type: multiselect
-_Choices: apache, apache-ssl, apache-perl, apache2
+__Choices: apache, apache-ssl, apache-perl, apache2
Default: apache, apache-ssl, apache-perl, apache2
-_Description: Automatical web server reconfiguration:
- If you do not select a web server to reconfigure automatically, ipplan
- will not be usable until you reconfigure your webserver to enable
- ipplan.
+_Description: Web server to reconfigure automatically:
+ Please choose the web server that should be automatically configured
+ to run ipplan.
This wording is the one that's always uses in such situations.
However, are you aware that such templates are obsolete? There is no
longer any apache, apache-ssl or paache-perl in unstable.
Template: ipplan/restart-webserver
Type: boolean
Default: false
_Description: Should ${webserver} be restarted?
- Remember that in order to activate the new configuration, ${webserver} has
+ In order to activate the new configuration, ${webserver} has
to be restarted. You can also restart ${webserver} by manually executing
'invoke-rc.d ${webserver} restart'.
Avoid the "remember to". There is no reason for the user to remember this..:-)
@@ -19,52 +18,51 @@
Type: boolean
Default: true
_Description: Configure MySQL?
- Please confirm whether ipplan should attempt to configure MySQL automatically.
+ Please confirm whether MySQL should be configured automatically.
+ .
If you do not choose this option, please see the instructions in
/usr/share/doc/ipplan/README.Debian.
- Ipplan could attempt to configure MySQL automatically. If you don't want, see
- the instructions in /usr/share/doc/ipplan/README.Debian. Do not choose this
- option if mysql-server is being installed along with ipplan. Read the file
- /usr/share/doc/mysql-serv/README.Debian to enable networking. It may be
- wise to set a new MySQL root password when installing mysql-server.
Strictly speaking, ipplan is not configuring MySQL. The maintainer
scripts are....
As there is no point going into such details, just say what's
important here.
Split this in a separate paragraph to improve readability.
Template: ipplan/mysql/dbserver
Type: string
Default: localhost
-_Description: MySQL Host:
- The name or IP of the host running MySQL that will store the ipplan
- database.
+_Description: MySQL host:
+ Please enter the name or IP address of the MySQL database server
+ that will store the ipplan database.
Remove extra capital in "Host"
Long description: make it a sentence. Use a quite common wording for
the "MySQL host": it is a database server.
For this and all other templates, you really should consider using
dbconfig-common which purposes is to provide a helper to packages
needing to setup databases.
Otherwise, such templates are repeated over packages and a really big
waste of translator's time.
Template: ipplan/mysql/dbadmin
Type: string
Default: root
-_Description: Database admin user who can create a database:
- Database admin user account capable of creating new databases.
+_Description: Database server administrator username:
+ Please enter the username of the database server administrator. This
+ account must have database creation privileges.
The 'root' user is the admin of the database *server*, not the
"database".
Move the "database creation rights" thing
to the long description and make it a real sentence.
Template: ipplan/purge
Type: boolean
Default: true
_Description: Delete database on purge?
- Please choose whether the database should be removed when ipplan is purged.
+ Please choose whether the database should be removed when the ipplan
+ package is purged.
As we menion "ipplan", this is indeed the package, not the
software. Otherwise, we should use "IPplan' for consistency.
Template: ipplan/mysql/dbname
Type: string
Default: ipplan
-_Description: ipplan database name:
- Name of the ipplan database.
+_Description: IPplan database name:
+ Please enter the name of the database that will host data for IPplan.
The database is for the software, so here use "IPplan".
Some details in the long description (and, again, make it a sentence)
Template: ipplan/mysql/dbadmpass
Type: password
-_Description: Database admin password:
- Password for the database admin user account.
+_Description: Database server administrator password:
No abbreviations.
No real need to repeat the exact same thing in the long description
Template: ipplan/mysql/dbuser
Type: string
Default: ipplan
-_Description: Database user who should access the ipplan database:
- Database user who should access the ipplan database.
+_Description: Database user for IPplan:
+ Please choose the MySQL account that will be used to access the
+ database hosting IPplan data.
A few more details about this always confusing concept of 'database owner'.
Template: ipplan/mysql/dbpass
Type: password
-_Description: Database password:
- Password for the database user account.
+_Description: Database user password:
+ Please choose the password for the account that will be used to
+ access the database hosting IPplan data.
Same rationale than former template
--- ../ipplan.old/debian/control 2007-11-16 07:12:27.034275579 +0000
+++ debian/control 2007-11-21 09:03:29.281474775 +0000
@@ -4,6 +4,7 @@
Maintainer: Jan Wagner <waja@cyconet.org>
Build-Depends: debhelper (>= 5), dpatch, gawk
Standards-Version: 3.7.2
+Homepage: http://iptrack.sourceforge.net/
Use the newly supported Homepage field
Package: ipplan
Architecture: all
@@ -11,11 +12,9 @@
Recommends: mysql-server, postgresql, php5-snmp | php4-snmp
Suggests: nmap
Description: web based IP address management software and tracking tool
- This tool goes beyond TCP IP address management including DNS administration,
+ IPplan goes beyond TCP IP address management including DNS administration,
configuration file management, circuit management (customizable via templates)
and storing of hardware information (customizable via templates). IPplan can
handle a single network or cater for multiple networks and customers with
overlapping address space. Makes managing ip addresses and managing ip address
space simple and easy!
- .
- Homepage: <http://iptrack.sourceforge.net/>
Better use "IPplan" than "this tool".
--
Template: ipplan/webserver_type
Type: multiselect
__Choices: apache, apache-ssl, apache-perl, apache2
Default: apache, apache-ssl, apache-perl, apache2
_Description: Web server to reconfigure automatically:
Please choose the web server that should be automatically configured
to run ipplan.
Template: ipplan/restart-webserver
Type: boolean
Default: false
_Description: Should ${webserver} be restarted?
In order to activate the new configuration, ${webserver} has
to be restarted. You can also restart ${webserver} by manually executing
'invoke-rc.d ${webserver} restart'.
Template: ipplan/mysql/configure
Type: boolean
Default: true
_Description: Configure MySQL?
Please confirm whether MySQL should be configured automatically.
.
If you do not choose this option, please see the instructions in
/usr/share/doc/ipplan/README.Debian.
Template: ipplan/mysql/dbserver
Type: string
Default: localhost
_Description: MySQL host:
Please enter the name or IP address of the MySQL database server
that will store the ipplan database.
Template: ipplan/mysql/dbadmin
Type: string
Default: root
_Description: Database server administrator username:
Please enter the username of the database server administrator. This
account must have database creation privileges.
Template: ipplan/purge
Type: boolean
Default: true
_Description: Delete database on purge?
Please choose whether the database should be removed when the ipplan
package is purged.
Template: ipplan/mysql/dbname
Type: string
Default: ipplan
_Description: IPplan database name:
Please enter the name of the database that will host data for IPplan.
Template: ipplan/mysql/dbadmpass
Type: password
_Description: Database server administrator password:
Template: ipplan/mysql/dbuser
Type: string
Default: ipplan
_Description: Database user for IPplan:
Please choose the MySQL account that will be used to access the
database hosting IPplan data.
Template: ipplan/mysql/dbpass
Type: password
_Description: Database user password:
Please choose the password for the account that will be used to
access the database hosting IPplan data.
--- ipplan.old/debian/templates 2007-11-16 07:12:27.034275579 +0000
+++ ipplan/debian/templates 2007-11-22 06:08:02.816127988 +0000
@@ -1,17 +1,16 @@
Template: ipplan/webserver_type
Type: multiselect
-_Choices: apache, apache-ssl, apache-perl, apache2
+__Choices: apache, apache-ssl, apache-perl, apache2
Default: apache, apache-ssl, apache-perl, apache2
-_Description: Automatical web server reconfiguration:
- If you do not select a web server to reconfigure automatically, ipplan
- will not be usable until you reconfigure your webserver to enable
- ipplan.
+_Description: Web server to reconfigure automatically:
+ Please choose the web server that should be automatically configured
+ to run ipplan.
Template: ipplan/restart-webserver
Type: boolean
Default: false
_Description: Should ${webserver} be restarted?
- Remember that in order to activate the new configuration, ${webserver} has
+ In order to activate the new configuration, ${webserver} has
to be restarted. You can also restart ${webserver} by manually executing
'invoke-rc.d ${webserver} restart'.
@@ -19,52 +18,51 @@
Type: boolean
Default: true
_Description: Configure MySQL?
- Please confirm whether ipplan should attempt to configure MySQL automatically.
+ Please confirm whether MySQL should be configured automatically.
+ .
If you do not choose this option, please see the instructions in
/usr/share/doc/ipplan/README.Debian.
- Ipplan could attempt to configure MySQL automatically. If you don't want, see
- the instructions in /usr/share/doc/ipplan/README.Debian. Do not choose this
- option if mysql-server is being installed along with ipplan. Read the file
- /usr/share/doc/mysql-serv/README.Debian to enable networking. It may be
- wise to set a new MySQL root password when installing mysql-server.
Template: ipplan/mysql/dbserver
Type: string
Default: localhost
-_Description: MySQL Host:
- The name or IP of the host running MySQL that will store the ipplan
- database.
+_Description: MySQL host:
+ Please enter the name or IP address of the MySQL database server
+ that will store the ipplan database.
Template: ipplan/mysql/dbadmin
Type: string
Default: root
-_Description: Database admin user who can create a database:
- Database admin user account capable of creating new databases.
+_Description: Database server administrator username:
+ Please enter the username of the database server administrator. This
+ account must have database creation privileges.
Template: ipplan/purge
Type: boolean
Default: true
_Description: Delete database on purge?
- Please choose whether the database should be removed when ipplan is purged.
+ Please choose whether the database should be removed when the ipplan
+ package is purged.
Template: ipplan/mysql/dbname
Type: string
Default: ipplan
-_Description: ipplan database name:
- Name of the ipplan database.
+_Description: IPplan database name:
+ Please enter the name of the database that will host data for IPplan.
Template: ipplan/mysql/dbadmpass
Type: password
-_Description: Database admin password:
- Password for the database admin user account.
+_Description: Database server administrator password:
Template: ipplan/mysql/dbuser
Type: string
Default: ipplan
-_Description: Database user who should access the ipplan database:
- Database user who should access the ipplan database.
+_Description: Database user for IPplan:
+ Please choose the MySQL account that will be used to access the
+ database hosting IPplan data.
Template: ipplan/mysql/dbpass
Type: password
-_Description: Database password:
- Password for the database user account.
+_Description: Database user password:
+ Please choose the password for the account that will be used to
+ access the database hosting IPplan data.
--- ipplan.old/debian/control 2007-11-16 07:12:27.034275579 +0000
+++ ipplan/debian/control 2007-11-21 09:03:29.281474775 +0000
@@ -4,6 +4,7 @@
Maintainer: Jan Wagner <waja@cyconet.org>
Build-Depends: debhelper (>= 5), dpatch, gawk
Standards-Version: 3.7.2
+Homepage: http://iptrack.sourceforge.net/
Package: ipplan
Architecture: all
@@ -11,11 +12,9 @@
Recommends: mysql-server, postgresql, php5-snmp | php4-snmp
Suggests: nmap
Description: web based IP address management software and tracking tool
- This tool goes beyond TCP IP address management including DNS administration,
+ IPplan goes beyond TCP IP address management including DNS administration,
configuration file management, circuit management (customizable via templates)
and storing of hardware information (customizable via templates). IPplan can
handle a single network or cater for multiple networks and customers with
overlapping address space. Makes managing ip addresses and managing ip address
space simple and easy!
- .
- Homepage: <http://iptrack.sourceforge.net/>
Source: ipplan Section: web Priority: optional Maintainer: Jan Wagner <waja@cyconet.org> Build-Depends: debhelper (>= 5), dpatch, gawk Standards-Version: 3.7.2 Homepage: http://iptrack.sourceforge.net/ Package: ipplan Architecture: all Depends: apache2 | httpd, php5 | php5-cgi | libapache2-mod-php5 | libapache-mod-php5 | php4 | php4-cgi | libapache2-mod-php4 | libapache-mod-php4, debconf (>= 0.2.26) | debconf-2.0, mysql-client | postgresql-client, wwwconfig-common, php5-mysql | php4-mysql | php5-pgsql | php4-pgsql, libphp-adodb, libphp-phplayersmenu, libphp-phpmailer Recommends: mysql-server, postgresql, php5-snmp | php4-snmp Suggests: nmap Description: web based IP address management software and tracking tool IPplan goes beyond TCP IP address management including DNS administration, configuration file management, circuit management (customizable via templates) and storing of hardware information (customizable via templates). IPplan can handle a single network or cater for multiple networks and customers with overlapping address space. Makes managing ip addresses and managing ip address space simple and easy!
Attachment:
signature.asc
Description: Digital signature