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

[RFR] templates://ircd-hybrid/{ircd-hybrid.templates}



Please find, for review, the debconf templates and packages descriptions for the ircd-hybrid source package.

This review will last from Friday, June 07, 2013 to Monday, June 17, 2013.

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, a summary will be sent to the review bug report,
and a mail will be sent to this list with "[BTS]" as a subject tag.

Rationale:
--- ircd-hybrid.old/debian/ircd-hybrid.templates	2013-06-03 07:12:27.370436479 +0200
+++ ircd-hybrid/debian/ircd-hybrid.templates	2013-06-07 19:25:02.686609803 +0200
@@ -1,14 +1,14 @@
 Template: ircd-hybrid/no-more-ssl
 Type: boolean
 Default: true
-_Description: All OpenSSL support is now disabled by default; continue?
- Due to licensing issues ircd-hybrid is no longer built by default with
+_Description: Continue with now disabled OpenSSL support?
+ Due to licensing issues, ircd-hybrid is no longer built by default with
  OpenSSL. This will be addressed in a future release, pending a rewrite
  of the SSL layer with GNUTLS.

We tend to avoid complicated sentences in templates synopsis. Hence my
simplication proposal.

Add a comma to where it belongs (imho).

  .
- If any of your existing server links take advantage of cryptlinks, refer
+ If any of existing server links take advantage of cryptlinks, refer
  to /usr/share/doc/ircd-hybrid/CRYPTLINKS.txt to find out how to build
- ircd-hybrid with SSL support (easily.)
+ ircd-hybrid with SSL support.

Drop "your": it might be not "my" server.

Drop "easily": indeed you don't know if that will be easy..:-)
 
 Template: ircd-hybrid/restart_on_upgrade
 Type: boolean
@@ -22,14 +22,14 @@
  the daemon would probably lead you to problems.
  .
  If you refuse, you have to restart ircd-hybrid yourself if you
- upgraded, by typing `invoke-rc.d ircd-hybrid restart' whenever it
+ upgraded, by typing "invoke-rc.d ircd-hybrid restart" whenever it
  suits you.

Use double quotes, which is what we standardized  in other reviews.
 
 Template: ircd-hybrid/upgrade_secure_links_warn
 Type: boolean
 Default: true
 _Description: Upgrade ircd-hybrid to version without cryptlink support?
- ircd-hybrid 8.x includes a change to the way secure server links are
+ The 8.x version of ircd-hybrid includes a change to the way secure server links are
  implemented, which is not backwards-compatible with ircd-hybrid 7.x,
  from which you are upgrading.
  .

Avoid leading lowercase letter forthe sentence

@@ -42,8 +42,8 @@
 Type: boolean
 Default: true
 _Description: Upgrade ircd-hybrid to version without compatible services?
- ircd-hybrid 8.x includes a change to the way services are supported, which
+ The 8.x version of ircd-hybrid includes a change to the way services are supported, which
  which is not compatible with hybserv.

Same here

  .
- It is planned to package anope, a Hybrid 8 compatible services system,
- later.
+ It is planned to package anope, an Hybrid 8-compatible services system,
+ in the future.

"later than what"? So, let's tell it will happen in the future..:-)


--- ircd-hybrid.old/debian/control	2013-06-03 07:12:27.370436479 +0200
+++ ircd-hybrid/debian/control	2013-06-07 19:26:35.965316177 +0200
@@ -28,12 +28,12 @@
 Description: high-performance secure IRC server
  ircd-hybrid is a stable, high-performance IRC server that features:
  .
-  * If enabled, SSL client support and server-to-server RSA encryption.
-  * Compressed server links
-  * Channel exceptions (+e) and invitation exceptions (+I).
-  * New configuration file format.
-  * Halfops (+h) and anti-spam user mode +g.
-  * Dynamically loadable modules.
+  * If enabled, SSL client support and server-to-server RSA encryption;
+  * Compressed server links;
+  * Channel exceptions (+e) and invitation exceptions (+I);
+  * New configuration file format;
+  * Halfops (+h) and anti-spam user mode +g;
+  * Dynamically loadable modules;
   * Channel and nickname RESV's (reservations).

Standardize on the use of semi-colons for enumerations.

  .
  It is also the IRC server of choice on the venerable EFnet, although
@@ -44,7 +44,7 @@
 Architecture: all
 Depends: ${misc:Depends}
 Suggests: ircd-hybrid
-Description: development files for ircd-hybrid
+Description: high-performance secure IRC server - development files
  These are the headers used when writing modules for ircd-hybrid.
  For more information on how to write these modules, see the ircd-hybrid
  documentation or example_module.c in the source code for ircd-hybrid.

Use the same style for tyhe synopsis, with a boilerplat.

Note that I'm not fond of the last paragraph ("if you have clued") but
couldn't find anything really appealing.

-- 


Template: ircd-hybrid/no-more-ssl
Type: boolean
Default: true
_Description: Continue with now disabled OpenSSL support?
 Due to licensing issues, ircd-hybrid is no longer built by default with
 OpenSSL. This will be addressed in a future release, pending a rewrite
 of the SSL layer with GNUTLS.
 .
 If any of existing server links take advantage of cryptlinks, refer
 to /usr/share/doc/ircd-hybrid/CRYPTLINKS.txt to find out how to build
 ircd-hybrid with SSL support.

Template: ircd-hybrid/restart_on_upgrade
Type: boolean
Default: true
_Description: Restart ircd-hybrid on each upgrade?
 You may choose whether or not you want to restart the ircd-hybrid
 daemon every time you install a new version of this package.
 .
 Sometimes, you do not want to do this. For instance, if you are doing
 the upgrade and loading IRCd modules at runtime. Failing to restart
 the daemon would probably lead you to problems.
 .
 If you refuse, you have to restart ircd-hybrid yourself if you
 upgraded, by typing "invoke-rc.d ircd-hybrid restart" whenever it
 suits you.

Template: ircd-hybrid/upgrade_secure_links_warn
Type: boolean
Default: true
_Description: Upgrade ircd-hybrid to version without cryptlink support?
 The 8.x version of ircd-hybrid includes a change to the way secure server links are
 implemented, which is not backwards-compatible with ircd-hybrid 7.x,
 from which you are upgrading.
 .
 If you have any secure server links (cryptlinks) configured with this
 server, you should plan to either upgrade all servers in lock-step, or
 temporarily configure non-cryptlink server links, to ensure the continuity
 of your IRC links.

Template: ircd-hybrid/upgrade_no_services_warn
Type: boolean
Default: true
_Description: Upgrade ircd-hybrid to version without compatible services?
 The 8.x version of ircd-hybrid includes a change to the way services are supported, which
 which is not compatible with hybserv.
 .
 It is planned to package anope, an Hybrid 8-compatible services system,
 in the future.
--- ircd-hybrid.old/debian/ircd-hybrid.templates	2013-06-03 07:12:27.370436479 +0200
+++ ircd-hybrid/debian/ircd-hybrid.templates	2013-06-07 19:25:02.686609803 +0200
@@ -1,14 +1,14 @@
 Template: ircd-hybrid/no-more-ssl
 Type: boolean
 Default: true
-_Description: All OpenSSL support is now disabled by default; continue?
- Due to licensing issues ircd-hybrid is no longer built by default with
+_Description: Continue with now disabled OpenSSL support?
+ Due to licensing issues, ircd-hybrid is no longer built by default with
  OpenSSL. This will be addressed in a future release, pending a rewrite
  of the SSL layer with GNUTLS.
  .
- If any of your existing server links take advantage of cryptlinks, refer
+ If any of existing server links take advantage of cryptlinks, refer
  to /usr/share/doc/ircd-hybrid/CRYPTLINKS.txt to find out how to build
- ircd-hybrid with SSL support (easily.)
+ ircd-hybrid with SSL support.
 
 Template: ircd-hybrid/restart_on_upgrade
 Type: boolean
@@ -22,14 +22,14 @@
  the daemon would probably lead you to problems.
  .
  If you refuse, you have to restart ircd-hybrid yourself if you
- upgraded, by typing `invoke-rc.d ircd-hybrid restart' whenever it
+ upgraded, by typing "invoke-rc.d ircd-hybrid restart" whenever it
  suits you.
 
 Template: ircd-hybrid/upgrade_secure_links_warn
 Type: boolean
 Default: true
 _Description: Upgrade ircd-hybrid to version without cryptlink support?
- ircd-hybrid 8.x includes a change to the way secure server links are
+ The 8.x version of ircd-hybrid includes a change to the way secure server links are
  implemented, which is not backwards-compatible with ircd-hybrid 7.x,
  from which you are upgrading.
  .
@@ -42,8 +42,8 @@
 Type: boolean
 Default: true
 _Description: Upgrade ircd-hybrid to version without compatible services?
- ircd-hybrid 8.x includes a change to the way services are supported, which
+ The 8.x version of ircd-hybrid includes a change to the way services are supported, which
  which is not compatible with hybserv.
  .
- It is planned to package anope, a Hybrid 8 compatible services system,
- later.
+ It is planned to package anope, an Hybrid 8-compatible services system,
+ in the future.
--- ircd-hybrid.old/debian/control	2013-06-03 07:12:27.370436479 +0200
+++ ircd-hybrid/debian/control	2013-06-07 19:26:35.965316177 +0200
@@ -28,12 +28,12 @@
 Description: high-performance secure IRC server
  ircd-hybrid is a stable, high-performance IRC server that features:
  .
-  * If enabled, SSL client support and server-to-server RSA encryption.
-  * Compressed server links
-  * Channel exceptions (+e) and invitation exceptions (+I).
-  * New configuration file format.
-  * Halfops (+h) and anti-spam user mode +g.
-  * Dynamically loadable modules.
+  * If enabled, SSL client support and server-to-server RSA encryption;
+  * Compressed server links;
+  * Channel exceptions (+e) and invitation exceptions (+I);
+  * New configuration file format;
+  * Halfops (+h) and anti-spam user mode +g;
+  * Dynamically loadable modules;
   * Channel and nickname RESV's (reservations).
  .
  It is also the IRC server of choice on the venerable EFnet, although
@@ -44,7 +44,7 @@
 Architecture: all
 Depends: ${misc:Depends}
 Suggests: ircd-hybrid
-Description: development files for ircd-hybrid
+Description: high-performance secure IRC server - development files
  These are the headers used when writing modules for ircd-hybrid.
  For more information on how to write these modules, see the ircd-hybrid
  documentation or example_module.c in the source code for ircd-hybrid.
Source: ircd-hybrid
Section: net
Priority: optional
Build-Depends: debhelper (>= 8),
 zlib1g-dev,
 docbook-to-man,
 flex,
 bison,
 libpcre3-dev (>= 6.3),
 automake1.13,
 dh-autoreconf,
 libltdl-dev 
Build-Conflicts: autoconf2.13
Maintainer: Dominic Hargreaves <dom@earth.li>
Standards-Version: 3.9.4
Homepage: http://ircd-hybrid.com/
Vcs-Browser: http://anonscm.debian.org/gitweb/?p=users/dom/ircd-hybrid.git
Vcs-Git: git://anonscm.debian.org/users/dom/ircd-hybrid.git

Package: ircd-hybrid
Architecture: any
Conflicts: ircd-ircu, ircd-irc2, dancer-ircd, oftc-hybrid
Pre-Depends: debconf (>= 0.5) | debconf-2.0
Depends: ${shlibs:Depends}, ${misc:Depends} 
Provides: ircd
Recommends: whois
Suggests: hybserv
Description: high-performance secure IRC server
 ircd-hybrid is a stable, high-performance IRC server that features:
 .
  * If enabled, SSL client support and server-to-server RSA encryption;
  * Compressed server links;
  * Channel exceptions (+e) and invitation exceptions (+I);
  * New configuration file format;
  * Halfops (+h) and anti-spam user mode +g;
  * Dynamically loadable modules;
  * Channel and nickname RESV's (reservations).
 .
 It is also the IRC server of choice on the venerable EFnet, although
 EFnet also uses the Ratbox, ComStud, and the Hybrid 6 IRCDs.

Package: hybrid-dev
Section: devel
Architecture: all
Depends: ${misc:Depends}
Suggests: ircd-hybrid
Description: high-performance secure IRC server - development files
 These are the headers used when writing modules for ircd-hybrid.
 For more information on how to write these modules, see the ircd-hybrid
 documentation or example_module.c in the source code for ircd-hybrid.
 .
 It also includes mbuild-hybrid, a shell script that simplifies building 
 and installation of such modules. This shell script is simplistic and
 assumes a lot; if you possess clue, you will know what to do anyway.

Attachment: signature.asc
Description: Digital signature


Reply to: