Re: [RFR] templates://ircd-hybrid/{ircd-hybrid.templates}
Christian PERRIER wrote:
> Template: ircd-hybrid/no-more-ssl
> Type: boolean
> Default: true
> -_Description: All OpenSSL support is now disabled by default; continue?
> +_Description: Continue with now disabled OpenSSL support?
>
> We tend to avoid complicated sentences in templates synopsis. Hence my
> simplication proposal.
"Continue with" is ambiguous (it sounds vaguely like some sort of
social security form asking if I want to continue with my claim for
Disabled Mobility Support). Maybe:
_Description: Continue despite OpenSSL support being disabled?
or
_Description: Continue installing version with disabled OpenSSL support?
I think I'll go for the second, just because it's clearer that this is
a case of "reject to abort install".
> - Due to licensing issues ircd-hybrid is no longer built by default with
> + 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.
>
> Add a comma to where it belongs (imho).
Agreed.
Oh, wait: GNUTLS upstream capitalises it oddly as 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.
>
> Drop "your": it might be not "my" server.
You need to drop the "of", too.
> Drop "easily": indeed you don't know if that will be easy..:-)
Maybe it's intended as:
If any existing server links take advantage of cryptlinks, see
/usr/share/doc/ircd-hybrid/CRYPTLINKS.txt for the easiest way to build
ircd-hybrid with SSL support.
> Template: ircd-hybrid/restart_on_upgrade
> Type: boolean
> Default: true
> You may choose whether or not you want to restart the ircd-hybrid
daemon every time you install a new version of this package.
I'm a lot less worried by second-person pronouns than Christian, but
I'm not keen on this focus on my emotional states! None of the 2p
pronouns really need to be here:
Please choose whether the ircd-hybrid daemon should be restarted
every time a new version of this package is installed.
> 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.
Ditto.
What does the bit about loading modules at runtime mean? Oh, if I've
got some modules loaded before the upgrade I'll need to re-load the
same set of modules after the restart - is that it? Well, bear in
mind that even if they were activated automatically by some
Apache-style modules-enabled.d linkfarm setup on restart, that would
still constitute loading them "at runtime". What you mean, I think,
is "loading IRCd modules manually".
Except... if that's an example where restarting the daemon would cause
problems, why does it then go on to say that *failing* to do so would
probably lead to problems? Is that just overnegation?
So maybe I'm misunderstanding, but my suggestion is:
Automatic restarts may be problematic if, for instance, the server is
running with manually loaded modules, which will need to be reloaded
after the restart.
> .
> 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.
It's compulsory to do it when you want to!
Isn't the current recommended interface "service"? "invoke-rc.d" is
supposed to be for maintainer scripts only these days.
Shortening it but not even taking out the pronoun:
If you reject this option, you will have to restart ircd-hybrid via
"service ircd-hybrid restart" when needed.
> Template: ircd-hybrid/upgrade_secure_links_warn
[...]
(Contains a good split infinitive.)
> 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.
^^^^^
Double which.
> .
> - 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..:-)
Plans are rarely about the past, so I'd just drop it. That should be
"a" before "Hybrid", but "Hybrid 8-compatible services system" is
pretty hard to parse. If Anope is being considered as a replacement
for hybserv, perhaps it would be clearer to say:
_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, losing compatibility with hybserv.
.
The plan is for hybserv to be replaced by anope, which is compatible
with Hybrid 8 services.
This phrasing also makes it a bit less urgent to rip the template
back out as soon as anope hits sid...
(Oh! Apparently "Anope" is so-called because it's based on Epona,
itself a classical reference, and not because it's pseudo-Greek for
"faceless". But I can't put it on wiki.debian.org/WhyTheName yet.)
Meanwhile in the control file:
> 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;
Still technically true!
> + * Compressed server links;
> + * Channel exceptions (+e) and invitation exceptions (+I);
> + * New configuration file format;
(How new, I wonder?)
> + * 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
> EFnet also uses the Ratbox, ComStud, and the Hybrid 6 IRCDs.
This paragraph is no longer true: http://stats.efnet.org/ says there
are 36 servers running ircd-ratbox, one running hybrid 8.0.6(SVN), and
nothing else.
> Package: hybrid-dev
[...]
> -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.
I'm not fond of it either, but it'll do.
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
diff -ru ircd-hybrid-8.0.9.dfsg.1.pristine/debian/control ircd-hybrid-8.0.9.dfsg.1/debian/control
--- ircd-hybrid-8.0.9.dfsg.1.pristine/debian/control 2013-06-01 00:58:39.000000000 +0100
+++ ircd-hybrid-8.0.9.dfsg.1/debian/control 2013-06-07 21:01:36.647859046 +0100
@@ -28,23 +28,20 @@
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
- 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: 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.
diff -ru ircd-hybrid-8.0.9.dfsg.1.pristine/debian/ircd-hybrid.templates ircd-hybrid-8.0.9.dfsg.1/debian/ircd-hybrid.templates
--- ircd-hybrid-8.0.9.dfsg.1.pristine/debian/ircd-hybrid.templates 2013-06-01 00:58:39.000000000 +0100
+++ ircd-hybrid-8.0.9.dfsg.1/debian/ircd-hybrid.templates 2013-06-07 21:01:23.408231459 +0100
@@ -1,36 +1,35 @@
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 installing version with 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.
+ of the SSL layer with GnuTLS.
.
- If any of your 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.)
+ If any existing server links take advantage of cryptlinks, see
+ /usr/share/doc/ircd-hybrid/CRYPTLINKS.txt for the easiest way 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.
+ Please choose whether the ircd-hybrid daemon should be restarted
+ every time a new version of this package is installed.
.
- 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.
+ Automatic restarts may be problematic if, for instance, the server is
+ running with manually loaded modules, which will need to be reloaded
+ after the restart.
.
- 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.
+ If you reject this option, you will have to restart ircd-hybrid via
+ "service ircd-hybrid restart" when needed.
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
- implemented, which is not backwards-compatible with ircd-hybrid 7.x,
+ 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
@@ -42,8 +41,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
- which is not compatible with hybserv.
+ The 8.x version of ircd-hybrid includes a change to the way services are
+ supported, losing compatibility with hybserv.
.
- It is planned to package anope, a Hybrid 8 compatible services system,
- later.
+ The plan is for hybserv to be replaced by anope, which is compatible
+ with Hybrid 8 services.
Template: ircd-hybrid/no-more-ssl
Type: boolean
Default: true
_Description: Continue installing version with 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 existing server links take advantage of cryptlinks, see
/usr/share/doc/ircd-hybrid/CRYPTLINKS.txt for the easiest way to build
ircd-hybrid with SSL support.
Template: ircd-hybrid/restart_on_upgrade
Type: boolean
Default: true
_Description: Restart ircd-hybrid on each upgrade?
Please choose whether the ircd-hybrid daemon should be restarted
every time a new version of this package is installed.
.
Automatic restarts may be problematic if, for instance, the server is
running with manually loaded modules, which will need to be reloaded
after the restart.
.
If you reject this option, you will have to restart ircd-hybrid via
"service ircd-hybrid restart" when needed.
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, losing compatibility with hybserv.
.
The plan is for hybserv to be replaced by anope, which is compatible
with Hybrid 8 services.
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).
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.
Reply to: