Re: [RFR] Description for package quassel
Thomas Müller wrote:
> PS: Please CC me.
> Package: quassel-core
> Architecture: any
> Depends: ${shlibs:Depends}, ${misc:Depends}, adduser, libqt4-sql-sqlite, lsb-base (>= 3.2-14), openssl
> Description: distributed IRC client - core component
I'm not keen on this terminology of Quassel being an IRC *client*
with a core and a *client* component - it seems unnecessarily
confusing. I'd suggest calling them "back-end" and "front-end"
components; but that's far too radical for a package description
review!
> This is the core component of Quassel. [...]
This sentence shouldn't be in the boilerplate.
> [...] A modern, cross-platform, distributed
> IRC client, meaning that one (or multiple) client(s) can attach to and detach
> from this central core. [...]
No verb. If we're throwing out the first sentence, it would make
sense to replace it with "Quassel is a..."
Using parentheses may seem logical, but it would be idiomatic
English just to say "one or more clients".
A knock-on effect: s/this/the/. (Mind you, if the core is
"central", that's not very "distributed"...)
> [...] It's much like the popular combination of screen and
> a text-based IRC client such as WeeChat, but graphical.
Judging by popcon scores you'd be much better off comparing irssi
rather than weechat.
So my revised boilerplate is:
Quassel is a modern, cross-platform, distributed IRC client, meaning that
one or more clients can attach to and detach from the central core. It's
much like the popular combination of screen and a text-based IRC client
such as irssi, but graphical.
> .
> This package installs only the core component.
I wouldn't bother nitpicking this if I hadn't been invited, but
saying that quassel-core _installs_ software makes it sound as if
it's a contrib installer package or something.
s/installs/provides/?
> Package: quassel-client
[...]
> Recommends: quassel-core
Do I gather that in principle you can use a quassel-client* package
without also having quassel-core installed on the same host? It
might be worth explaining that dependency here. Otherwise, fine.
> Package: quassel
[...]
> Description: distributed IRC client - Qt-based monolithic client (core+client)
That's getting a bit long (and the "KDE-based" one is a character
longer). It has three repetitions of the word "client"... make it:
Description: distributed IRC client - Qt-based monolithic core+client
> .
> This package installs the monolithic client. This contains both core and
> client and can be used like a traditional IRC client, without requiring an
> external core.
Uh... why would anyone want that? Does Quassel have any selling
points apart from the one that this version leaves out? And how
does providing both in one package provide any benefit to Debian
users? It's only one "apt-get install" invocation either way.
Again s/installs/provides/, and in the second sentence s/This/It/.
> Package: quassel-data
[...]
> Description: distributed IRC client - various shared data
No need to say it's various. Come to that, if it's only needed by
the Qt flavours it presumably isn't all that various. To sit neatly
alongside quassel-data-kde4 I'd suggest:
Description: distributed IRC client - shared data (Qt version)
[...]
> This package installs files used by the Qt-based client as well as the Qt-based
> monolithic client.
This package provides files used by the Qt-based Quassel client
packages.
> Package: quassel-client-kde4
[...]
> Description: distributed IRC client - KDE-based client
I'm rarely happy with "foo-based" in package synopses; it's
developerese shorthand. I mean, you didn't start with KDE and then
modify it to produce Quassel, did you? You just mean "compiled
using the KDE libraries". Or translating that into an end-user
point of view, what you mean to say is "[program] for KDE" or just
"KDE [program]". Unfortunately there's no equivalent translation of
"Qt-based", and moving "KDE-based" would leave "client client" in
the middle of this synopsis, so it's too much effort to fix...
[...]
> This package installs only the client component compiled with KDE4 support.
If you add explanations to quassel-client they should also go here.
> Package: quassel-kde4
[...]
> Description: distributed IRC client - KDE-based monolithic client (core+client)
Same changes ("KDE-based monolithic core+client"), same questions
about the reason for its existence.
> Package: quassel-data-kde4
[...]
> Description: distributed IRC client - various shared data for KDE4 packages
Description: distributed IRC client - shared data (KDE4 version)
[...]
> This package installs files used by the KDE-based client as well as the
> KDE-based monolithic client.
This package provides files used by the KDE4-based Quassel client
packages.
(You might also consider being kind to non-teutonophones wondering
what "quassel" means, but that could go elsewhere in the
documentation.)
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
--- control.orig 2010-01-31 13:19:24.000000000 +0000
+++ control 2010-01-31 13:39:42.000000000 +0000
@@ -7,17 +7,16 @@
Homepage: http://www.quassel-irc.org
Standards-Version: 3.8.4
-
Package: quassel-core
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, adduser, libqt4-sql-sqlite, lsb-base (>= 3.2-14), openssl
Description: distributed IRC client - core component
- This is the core component of Quassel. A modern, cross-platform, distributed
- IRC client, meaning that one (or multiple) client(s) can attach to and detach
- from this central core. It's much like the popular combination of screen and
- a text-based IRC client such as WeeChat, but graphical.
+ Quassel is a modern, cross-platform, distributed IRC client, meaning that
+ one or more clients can attach to and detach from the central core. It's
+ much like the popular combination of screen and a text-based IRC client
+ such as irssi, but graphical.
.
- This package installs only the core component.
+ This package provides only the core component.
Package: quassel-client
Architecture: any
@@ -26,24 +25,24 @@
Replaces: quassel (<< 0.3.1-1)
Recommends: quassel-core
Description: distributed IRC client - Qt-based client component
- This is the core component of Quassel. A modern, cross-platform, distributed
- IRC client, meaning that one (or multiple) client(s) can attach to and detach
- from this central core. It's much like the popular combination of screen and
- a text-based IRC client such as WeeChat, but graphical.
+ Quassel is a modern, cross-platform, distributed IRC client, meaning that
+ one or more clients can attach to and detach from the central core. It's
+ much like the popular combination of screen and a text-based IRC client
+ such as irssi, but graphical.
.
- This package installs only the client component.
+ This package provides only the client component.
Package: quassel
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, libqt4-sql-sqlite, quassel-data (= ${source:Version}), dbus-x11
Conflicts: quassel-kde4
-Description: distributed IRC client - Qt-based monolithic client (core+client)
- This is the core component of Quassel. A modern, cross-platform, distributed
- IRC client, meaning that one (or multiple) client(s) can attach to and detach
- from this central core. It's much like the popular combination of screen and
- a text-based IRC client such as WeeChat, but graphical.
+Description: distributed IRC client - Qt-based monolithic core+client
+ Quassel is a modern, cross-platform, distributed IRC client, meaning that
+ one or more clients can attach to and detach from the central core. It's
+ much like the popular combination of screen and a text-based IRC client
+ such as irssi, but graphical.
.
- This package installs the monolithic client. This contains both core and
+ This package provides the monolithic client. It contains both core and
client and can be used like a traditional IRC client, without requiring an
external core.
@@ -52,14 +51,14 @@
Depends: ${misc:Depends}
Conflicts: quassel (<< 0.3.1-1), quassel-data-kde4
Replaces: quassel (<< 0.3.1-1)
-Description: distributed IRC client - various shared data
- This is the core component of Quassel. A modern, cross-platform, distributed
- IRC client, meaning that one (or multiple) client(s) can attach to and detach
- from this central core. It's much like the popular combination of screen and
- a text-based IRC client such as WeeChat, but graphical.
+Description: distributed IRC client - shared data (Qt version)
+ Quassel is a modern, cross-platform, distributed IRC client, meaning that
+ one or more clients can attach to and detach from the central core. It's
+ much like the popular combination of screen and a text-based IRC client
+ such as irssi, but graphical.
.
- This package installs files used by the Qt-based client as well as the Qt-based
- monolithic client.
+ This package provides files used by the Qt-based Quassel client
+ packages.
Package: quassel-client-kde4
Architecture: any
@@ -67,37 +66,37 @@
Conflicts: quassel-client
Recommends: quassel-core
Description: distributed IRC client - KDE-based client
- This is the core component of Quassel. A modern, cross-platform, distributed
- IRC client, meaning that one (or multiple) client(s) can attach to and detach
- from this central core. It's much like the popular combination of screen and
- a text-based IRC client such as WeeChat, but graphical.
+ Quassel is a modern, cross-platform, distributed IRC client, meaning that
+ one or more clients can attach to and detach from the central core. It's
+ much like the popular combination of screen and a text-based IRC client
+ such as irssi, but graphical.
.
- This package installs only the client component compiled with KDE4 support.
+ This package provides only the client component compiled with KDE4 support.
Package: quassel-kde4
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, libqt4-sql-sqlite, quassel-data-kde4 (= ${source:Version}), dbus-x11
Conflicts: quassel
-Description: distributed IRC client - KDE-based monolithic client (core+client)
- This is the core component of Quassel. A modern, cross-platform, distributed
- IRC client, meaning that one (or multiple) client(s) can attach to and detach
- from this central core. It's much like the popular combination of screen and
- a text-based IRC client such as WeeChat, but graphical.
- .
- This package installs the monolithic client compiled with KDE4 support. This
- contains both core and client and can be used like a traditional IRC client,
- without requiring an external core.
+Description: distributed IRC client - KDE-based monolithic core+client
+ Quassel is a modern, cross-platform, distributed IRC client, meaning that
+ one or more clients can attach to and detach from the central core. It's
+ much like the popular combination of screen and a text-based IRC client
+ such as irssi, but graphical.
+ .
+ This package provides the monolithic client compiled with KDE4 support.
+ It contains both core and client and can be used like a traditional IRC
+ client, without requiring an external core.
Package: quassel-data-kde4
Architecture: all
Depends: ${misc:Depends}
Conflicts: quassel (<< 0.3.1-1), quassel-data
Replaces: quassel (<< 0.3.1-1)
-Description: distributed IRC client - various shared data for KDE4 packages
- This is the core component of Quassel. A modern, cross-platform, distributed
- IRC client, meaning that one (or multiple) client(s) can attach to and detach
- from this central core. It's much like the popular combination of screen and
- a text-based IRC client such as WeeChat, but graphical.
+Description: distributed IRC client - shared data (KDE4 version)
+ Quassel is a modern, cross-platform, distributed IRC client, meaning that
+ one or more clients can attach to and detach from the central core. It's
+ much like the popular combination of screen and a text-based IRC client
+ such as irssi, but graphical.
.
- This package installs files used by the KDE-based client as well as the
- KDE-based monolithic client.
+ This package provides files used by the KDE4-based Quassel client
+ packages.
Source: quassel
Section: net
Priority: optional
Maintainer: Thomas Mueller <thomas.mueller@tmit.eu>
DM-Upload-Allowed: yes
Build-Depends: debhelper (>= 7.0.50~), quilt (>= 0.46-7), libqt4-dev, cmake, libfontconfig1-dev, libfreetype6-dev, libpng12-dev, libsm-dev, libice-dev, libxi-dev, libxrandr-dev, libxrender-dev, zlib1g-dev, libssl-dev, libdbus-1-dev, pkg-kde-tools, kdelibs5-dev
Homepage: http://www.quassel-irc.org
Standards-Version: 3.8.4
Package: quassel-core
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, adduser, libqt4-sql-sqlite, lsb-base (>= 3.2-14), openssl
Description: distributed IRC client - core component
Quassel is a modern, cross-platform, distributed IRC client, meaning that
one or more clients can attach to and detach from the central core. It's
much like the popular combination of screen and a text-based IRC client
such as irssi, but graphical.
.
This package provides only the core component.
Package: quassel-client
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, quassel-data (= ${source:Version}), dbus-x11
Conflicts: quassel (<< 0.3.1-1), quassel-client-kde4
Replaces: quassel (<< 0.3.1-1)
Recommends: quassel-core
Description: distributed IRC client - Qt-based client component
Quassel is a modern, cross-platform, distributed IRC client, meaning that
one or more clients can attach to and detach from the central core. It's
much like the popular combination of screen and a text-based IRC client
such as irssi, but graphical.
.
This package provides only the client component.
Package: quassel
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, libqt4-sql-sqlite, quassel-data (= ${source:Version}), dbus-x11
Conflicts: quassel-kde4
Description: distributed IRC client - Qt-based monolithic core+client
Quassel is a modern, cross-platform, distributed IRC client, meaning that
one or more clients can attach to and detach from the central core. It's
much like the popular combination of screen and a text-based IRC client
such as irssi, but graphical.
.
This package provides the monolithic client. It contains both core and
client and can be used like a traditional IRC client, without requiring an
external core.
Package: quassel-data
Architecture: all
Depends: ${misc:Depends}
Conflicts: quassel (<< 0.3.1-1), quassel-data-kde4
Replaces: quassel (<< 0.3.1-1)
Description: distributed IRC client - shared data (Qt version)
Quassel is a modern, cross-platform, distributed IRC client, meaning that
one or more clients can attach to and detach from the central core. It's
much like the popular combination of screen and a text-based IRC client
such as irssi, but graphical.
.
This package provides files used by the Qt-based Quassel client
packages.
Package: quassel-client-kde4
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, quassel-data-kde4 (=${source:Version}), dbus-x11
Conflicts: quassel-client
Recommends: quassel-core
Description: distributed IRC client - KDE-based client
Quassel is a modern, cross-platform, distributed IRC client, meaning that
one or more clients can attach to and detach from the central core. It's
much like the popular combination of screen and a text-based IRC client
such as irssi, but graphical.
.
This package provides only the client component compiled with KDE4 support.
Package: quassel-kde4
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, libqt4-sql-sqlite, quassel-data-kde4 (= ${source:Version}), dbus-x11
Conflicts: quassel
Description: distributed IRC client - KDE-based monolithic core+client
Quassel is a modern, cross-platform, distributed IRC client, meaning that
one or more clients can attach to and detach from the central core. It's
much like the popular combination of screen and a text-based IRC client
such as irssi, but graphical.
.
This package provides the monolithic client compiled with KDE4 support.
It contains both core and client and can be used like a traditional IRC
client, without requiring an external core.
Package: quassel-data-kde4
Architecture: all
Depends: ${misc:Depends}
Conflicts: quassel (<< 0.3.1-1), quassel-data
Replaces: quassel (<< 0.3.1-1)
Description: distributed IRC client - shared data (KDE4 version)
Quassel is a modern, cross-platform, distributed IRC client, meaning that
one or more clients can attach to and detach from the central core. It's
much like the popular combination of screen and a text-based IRC client
such as irssi, but graphical.
.
This package provides files used by the KDE4-based Quassel client
packages.
Reply to: