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

[RFR] templates://shorewall-common/{shorewall-common.templates}



Please find, for review, the debconf templates and packages descriptions for the shorewall-common source package.

This review will last from Wednesday, December 05, 2007 to Saturday, December 15, 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:
--- ../shorewall-common.old/debian/shorewall-common.templates	2007-11-24 13:43:27.265477173 +0530
+++ debian/shorewall-common.templates	2007-11-30 12:04:18.824909043 +0530
@@ -1,21 +1,21 @@
 Template: shorewall-common/dont_restart
 Type: note
-_Description: Shorewall won't be restarted automatically
- This will prevent network blackout due to changes in configuration files.
+_Description: No automatic restart for Shorewall

Avoid sentences in note/error templates short descriptions

+ Shorewall will not be restarted automatically after being upgraded.

Not sure about tense, here. Justin?

+ This will prevent network outages due to changes in configuration files.

Avoid "linking" the long description to the short one.

  .
- Check your configuration and then restart Shorewall issuing:
- .
-         invoke-rc.d shorewall restart
- .
- or
- .
-         /etc/init.d/shorewall restart
+ You should check Shorewall's configuration files and restart it with
+ 'invoke-rc.d shorewall restart'.

Siplify the layout. Avoid "personnalization" (*your* configuration files).

 
 Template: shorewall-common/major_release
 Type: boolean
-_Description: Do you want to restart Shorewall right now? 
- This is a major release of Shorewall that introduces some changes in the
- configuration files. You have to check carefully your configuration before
- restarting your firewall to avoid failures and network blackout. The changes
- are listed in /usr/share/doc/shorewall/releasenotes.txt.gz.
-
+_Description: Restart Shorewall? 

Simplify the wording and avoid the "right now" as the restart could
happen a little bit later..:-)

+ Shorewall is being upgraded to major version that introduces some
+ changes in the configuration files.
+ .
+ These files should be checked carefully before restarting the
+ firewall, to avoid failures and network outages. Please read the
+ /usr/share/doc/shorewall/releasenotes.txt.gz file for more
+ information.
+ .
+ Please choose whether you want to restart Shorewall immediately.

Split in paragraphs for readability.

Avoid "this is" and use a more factual wording. Unpersonnalize.

Finally, repeat what acton is expected which is common in boolean
templates' long description.

--- ../shorewall-common.old/debian/control	2007-11-24 13:43:27.265477173 +0530
+++ debian/control	2007-11-30 12:06:42.317351247 +0530
@@ -14,11 +14,11 @@
 Suggests: shorewall-doc, linux-image, make
 Conflicts: ipmasq, knetfilter, firewall-easy, filtergen, uif, webmin-firewall, ipmenu, gnome-lokkit, guarddog, guidedog, ferm
 Replaces: shorewall
-Description: Shoreline Firewall, netfilter configurator (common files)
- Shorewall allows you to describe your firewall/gateway requirements
+Description: Shoreline Firewall, netfilter configurator - common files

Standard "common description - specific description" style

+ Shorewall allows describing firewall/gateway requirements
  using entries in a set of configuration files. It reads those
  configuration files and, with the help of the iptables utility,
- configures Netfilter to match your requirements.
+ configures Netfilter to match these requirements.

Unpersonnalize.

  .
  Shorewall supports a wide range of router/firewall/gateway applications,
  traffic shaping and almost every type of VPN.
@@ -29,7 +29,7 @@
 Package: shorewall
 Architecture: all
 Depends: shorewall-shell
-Description: Shoreline Firewall (transitional package)
- This package is simply to facilitate the transition to shorewall-shell.
- You may remove it at your convenience.
+Description: Shoreline Firewall, netfilter configurator - transitional package
+ This package is a transition package to shorewall-shell. It can be safely
+ removed.
 
Common wording for transition packages.


-- 


Template: shorewall-common/dont_restart
Type: note
_Description: No automatic restart for Shorewall
 Shorewall will not be restarted automatically after being upgraded.
 This will prevent network outages due to changes in configuration files.
 .
 You should check Shorewall's configuration files and restart it with
 'invoke-rc.d shorewall restart'.

Template: shorewall-common/major_release
Type: boolean
_Description: Restart Shorewall? 
 Shorewall is being upgraded to major version that introduces some
 changes in the configuration files.
 .
 These files should be checked carefully before restarting the
 firewall, to avoid failures and network outages. Please read the
 /usr/share/doc/shorewall/releasenotes.txt.gz file for more
 information.
 .
 Please choose whether you want to restart Shorewall immediately.
--- ../shorewall-common.old/debian/shorewall-common.templates	2007-11-24 13:43:27.265477173 +0530
+++ debian/shorewall-common.templates	2007-11-30 12:04:18.824909043 +0530
@@ -1,21 +1,21 @@
 Template: shorewall-common/dont_restart
 Type: note
-_Description: Shorewall won't be restarted automatically
- This will prevent network blackout due to changes in configuration files.
+_Description: No automatic restart for Shorewall
+ Shorewall will not be restarted automatically after being upgraded.
+ This will prevent network outages due to changes in configuration files.
  .
- Check your configuration and then restart Shorewall issuing:
- .
-         invoke-rc.d shorewall restart
- .
- or
- .
-         /etc/init.d/shorewall restart
+ You should check Shorewall's configuration files and restart it with
+ 'invoke-rc.d shorewall restart'.
 
 Template: shorewall-common/major_release
 Type: boolean
-_Description: Do you want to restart Shorewall right now? 
- This is a major release of Shorewall that introduces some changes in the
- configuration files. You have to check carefully your configuration before
- restarting your firewall to avoid failures and network blackout. The changes
- are listed in /usr/share/doc/shorewall/releasenotes.txt.gz.
-
+_Description: Restart Shorewall? 
+ Shorewall is being upgraded to major version that introduces some
+ changes in the configuration files.
+ .
+ These files should be checked carefully before restarting the
+ firewall, to avoid failures and network outages. Please read the
+ /usr/share/doc/shorewall/releasenotes.txt.gz file for more
+ information.
+ .
+ Please choose whether you want to restart Shorewall immediately.
--- ../shorewall-common.old/debian/control	2007-11-24 13:43:27.265477173 +0530
+++ debian/control	2007-11-30 12:06:42.317351247 +0530
@@ -14,11 +14,11 @@
 Suggests: shorewall-doc, linux-image, make
 Conflicts: ipmasq, knetfilter, firewall-easy, filtergen, uif, webmin-firewall, ipmenu, gnome-lokkit, guarddog, guidedog, ferm
 Replaces: shorewall
-Description: Shoreline Firewall, netfilter configurator (common files)
- Shorewall allows you to describe your firewall/gateway requirements
+Description: Shoreline Firewall, netfilter configurator - common files
+ Shorewall allows describing firewall/gateway requirements
  using entries in a set of configuration files. It reads those
  configuration files and, with the help of the iptables utility,
- configures Netfilter to match your requirements.
+ configures Netfilter to match these requirements.
  .
  Shorewall supports a wide range of router/firewall/gateway applications,
  traffic shaping and almost every type of VPN.
@@ -29,7 +29,7 @@
 Package: shorewall
 Architecture: all
 Depends: shorewall-shell
-Description: Shoreline Firewall (transitional package)
- This package is simply to facilitate the transition to shorewall-shell.
- You may remove it at your convenience.
+Description: Shoreline Firewall, netfilter configurator - transitional package
+ This package is a transition package to shorewall-shell. It can be safely
+ removed.
 
Source: shorewall-common
Section: net
Priority: optional
Maintainer: Roberto C. Sanchez <roberto@connexer.com>
Homepage: http://www.shorewall.net
Build-Depends: debhelper (>> 5), dpatch, po-debconf
Standards-Version: 3.7.2
Vcs-Browser: http://shorewall.svn.sourceforge.net/viewvc/shorewall/
Vcs-Svn: https://shorewall.svn.sourceforge.net/svnroot/shorewall/

Package: shorewall-common
Architecture: all
Depends: iptables (>= 1.2.7a), iproute, debconf | debconf-2.0
Suggests: shorewall-doc, linux-image, make
Conflicts: ipmasq, knetfilter, firewall-easy, filtergen, uif, webmin-firewall, ipmenu, gnome-lokkit, guarddog, guidedog, ferm
Replaces: shorewall
Description: Shoreline Firewall, netfilter configurator - common files
 Shorewall allows describing firewall/gateway requirements
 using entries in a set of configuration files. It reads those
 configuration files and, with the help of the iptables utility,
 configures Netfilter to match these requirements.
 .
 Shorewall supports a wide range of router/firewall/gateway applications,
 traffic shaping and almost every type of VPN.
 .
 This package contains files needed by both the perl-based and
 shell-based compilers.

Package: shorewall
Architecture: all
Depends: shorewall-shell
Description: Shoreline Firewall, netfilter configurator - transitional package
 This package is a transition package to shorewall-shell. It can be safely
 removed.

Attachment: signature.asc
Description: Digital signature


Reply to: