Please find, for review, the debconf templates and packages descriptions for the aolserver4 source package.
This review will last from Wednesday, March 11, 2009 to Saturday, March 21, 2009.
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:
--- aolserver4.old/debian/aolserver4.templates 2009-03-09 08:26:43.163102951 +0100
+++ aolserver4/debian/aolserver4.templates 2009-03-11 18:55:57.095578288 +0100
@@ -2,7 +2,7 @@
Type: string
Default: localhost
_Description: Server hostname:
- AOLserver server needs an hostname to be exposed on redirect pages URL and for
+ AOLserver needs an hostname to be exposed on redirect pages URL and for
informative purposes to identify itself.
.
It is generally the fully-qualified DNS hostname of the computer or
Try avoiding the repetition.
@@ -12,13 +12,13 @@
Template: aolserver4/address
Type: string
Default: 127.0.0.1
-_Description: Server IP address number:
+_Description: Server IP address:
We rarely talk about IP address *numbers*
AOLserver needs at least an IP address to listen to.
It is generally the primary Ethernet interface (or the loopback address,
if the server will be used just locally).
.
- The default address is the loopback one, which is not recommended
- for general (network or Internet) use.
+ It is not recommended to use the loopback address (127.0.0.1)
+ for use on a network.
It is generally not recommended to explicitely talk about default
values (anyway, the default value is obvious as it appears...by
default).
So, tell this differently.
"for use on a network" could be replaced by "for networked operations"....
Template: aolserver4/port
Type: string
@@ -28,6 +28,3 @@
port 80 (the standard HTTP port), but might be different if another
web server is installed, or some other service is listening on
that port.
- .
- It is recommended using the default.
- .
It's always recommended, isn't it? :-)
--- aolserver4.old/debian/control 2009-03-09 08:26:43.146951462 +0100
+++ aolserver4/debian/control 2009-03-11 19:03:20.987578180 +0100
@@ -14,24 +14,26 @@
Recommends: aolserver4-doc
Conflicts: aolserver4-nscache
Replaces: aolserver4-nscache
-Description: AOL Web Server 4 (Program)
- This is the web engine that powers the mighty America On-Line. It
- is capable of serving a tremendous number of users, and can publish
- hundreds of virtual servers within the same process at the same time.
+Description: AOL web server version 4 - program files
Use the common format in such cases: a repetitive part use in all
packages synopsis and a specific part, separated by space-dash-space
+ AOLserver is the web engine that powers the America On-Line server. It
+ is capable of serving a very high number of users, and can host
+ simultaneously hundreds of virtual servers within the same process.
.
It is similar in many respects to Zope, except based largely on Tcl.
It is multi-threaded, and has a C API that can be used to extend
its functionality.
These both paragraphs are used as a boiler plate in all
packages...leaving up to the third one to explain what is specific in
each package.
Proposed changes:
- "This is" --> "AOLServer is". The rationale is the long description
being potentially used alone, without the synopsis...Using "This"
makes an explicit link between both. We sometimes propose "Thsi
package provides..." but, here, we can make this simpler
- "the mighty" --> less and less mighty, IMHO..:-)...so leaving out
the non factual part
- "tremendous" --> "very high". What is tremendous at one moment might
sound low later on...:)
+ .
+ This package provides the core programs needed to run the server.
Add a specific part to that package...
Package: aolserver4-core
Architecture: any
Depends: debconf (>= 1.2.9) | debconf-2.0, ${shlibs:Depends}, ${misc:Depends}
Provides: httpd, httpd-cgi
Recommends: aolserver4-doc
-Description: AOL Web Server 4 (Core libraries)
- This is the web engine that powers the mighty America On-Line. It
- is capable of serving a tremendous number of users, and can publish
- hundreds of virtual servers within the same process at the same time.
+Description: AOL web server version 4 - core libraries
+ AOLserver is the web engine that powers the America On-Line server. It
+ is capable of serving a very high number of users, and can host
+ simultaneously hundreds of virtual servers within the same process.
.
It is similar in many respects to Zope, except based largely on Tcl.
It is multi-threaded, and has a C API that can be used to extend
@@ -39,7 +41,7 @@
.
This package contains the basic shared libraries which are useful
for building add-on modules and are used also by the daemon.
- It does *not* contain the AOLserver daemon, which can be installed
+ It does not contain the AOLserver daemon, which can be installed
using aolserver4 package instead.
While one might understand you want to insist on the "not", we should
leave it up to the reader's intelligence to notice it. Otherwise, we
would end up with packages descriptions having "pseudo-bold" artefacts
here and there...
Package: aolserver4-dev
@@ -48,13 +50,17 @@
Depends: aolserver4-core (= ${binary:Version}), tcl-dev (>= 8.4), zlib1g-dev | libz-dev, ${misc:Depends}
Suggests: aolserver4-doc, aolserver4
Conflicts: aolserver4 (<< 4.5.1-1)
-Description: AOL Web Server 4 (Development Tools)
- This package includes the header files and static libraries needed
- to compile extensions and modules for AOLserver. The header files
- used to be part of the AOLserver package, but have been moved to
- this new package to reduce cruft on non-developer systems.
+Description: AOL web server version 4 - development files
+ AOLserver is the web engine that powers the America On-Line server. It
+ is capable of serving a very high number of users, and can host
+ simultaneously hundreds of virtual servers within the same process.
+ .
+ It is similar in many respects to Zope, except based largely on Tcl.
+ It is multi-threaded, and has a C API that can be used to extend
+ its functionality.
.
- This package contains version 4.x of AOLServer Development Tools.
+ This package contains header files and libraries needed to develop
+ applications based on AOLServer.
Common formula for the -dev packages
Package: aolserver4-doc
Section: doc
@@ -62,18 +68,25 @@
Depends: ${misc:Depends}
Recommends: www-browser
Suggests: aolserver4, tcl-doc
-Description: AOL Web Server 4 (Documentation)
- This package contains three reference manuals relating to AOLserver.
- The manuals document Version 3+ of AOLserver.
- .
- (1) The AOLserver Administrator's Guide covers the setup options
- and security issues relating to running the server.
- (2) The AOLserver Tcl Developer's Guide covers the Tcl API which
- can be used to add features to your web pages (similar in
- some respects to PHP or Microsoft's ASP)
- (3) The AOLserver C Developer's Guide covers the C API which can
- be used to create new modules to extend AOLserver.
+Description: AOL web server version 4 - documentation
+ AOLserver is the web engine that powers the America On-Line server. It
+ is capable of serving a very high number of users, and can host
+ simultaneously hundreds of virtual servers within the same process.
+ .
+ It is similar in many respects to Zope, except based largely on Tcl.
+ It is multi-threaded, and has a C API that can be used to extend
+ its functionality.
+ .
+ This package contains three reference manuals relating to the version
+ 3+ of AOLserver:
+ - The AOLserver Administrator's Guide covers the setup options
+ and security issues relating to running the server;
+ - The AOLserver Tcl Developer's Guide covers the Tcl API which
+ can be used to add features to your web pages (similar in
+ some respects to PHP or Microsoft's ASP);
+ - The AOLserver C Developer's Guide covers the C API which can
+ be used to create new modules to extend AOLserver.
.
This the latest available version of AOLServer documentation, but
- it is quite outdated and incomplete. Un up-to-date API documentation
- is available at http://panoptic.com/wiki/aolserver/Tcl_API
+ it is quite outdated and incomplete. An up-to-date API documentation
+ is available at http://panoptic.com/wiki/aolserver/Tcl_API.
Revamp that one:
- add the boilerplate
- use the standard enumeration style
Finally, correct spelling error: "Un" --> "An"...and add a dot at the
end of the sentence....
--
Template: aolserver4/hostname Type: string Default: localhost _Description: Server hostname: AOLserver needs an hostname to be exposed on redirect pages URL and for informative purposes to identify itself. . It is generally the fully-qualified DNS hostname of the computer or localhost, if it is not networked. Any name which can be legally considered for a URL string can be used. Template: aolserver4/address Type: string Default: 127.0.0.1 _Description: Server IP address: AOLserver needs at least an IP address to listen to. It is generally the primary Ethernet interface (or the loopback address, if the server will be used just locally). . It is not recommended to use the loopback address (127.0.0.1) for use on a network. Template: aolserver4/port Type: string Default: 80 _Description: Server TCP port: AOLserver needs a port number assigned for its use. This is almost always port 80 (the standard HTTP port), but might be different if another web server is installed, or some other service is listening on that port.
--- aolserver4.old/debian/aolserver4.templates 2009-03-09 08:26:43.163102951 +0100
+++ aolserver4/debian/aolserver4.templates 2009-03-11 18:55:57.095578288 +0100
@@ -2,7 +2,7 @@
Type: string
Default: localhost
_Description: Server hostname:
- AOLserver server needs an hostname to be exposed on redirect pages URL and for
+ AOLserver needs an hostname to be exposed on redirect pages URL and for
informative purposes to identify itself.
.
It is generally the fully-qualified DNS hostname of the computer or
@@ -12,13 +12,13 @@
Template: aolserver4/address
Type: string
Default: 127.0.0.1
-_Description: Server IP address number:
+_Description: Server IP address:
AOLserver needs at least an IP address to listen to.
It is generally the primary Ethernet interface (or the loopback address,
if the server will be used just locally).
.
- The default address is the loopback one, which is not recommended
- for general (network or Internet) use.
+ It is not recommended to use the loopback address (127.0.0.1)
+ for use on a network.
Template: aolserver4/port
Type: string
@@ -28,6 +28,3 @@
port 80 (the standard HTTP port), but might be different if another
web server is installed, or some other service is listening on
that port.
- .
- It is recommended using the default.
- .
--- aolserver4.old/debian/control 2009-03-09 08:26:43.146951462 +0100
+++ aolserver4/debian/control 2009-03-11 19:03:20.987578180 +0100
@@ -14,24 +14,26 @@
Recommends: aolserver4-doc
Conflicts: aolserver4-nscache
Replaces: aolserver4-nscache
-Description: AOL Web Server 4 (Program)
- This is the web engine that powers the mighty America On-Line. It
- is capable of serving a tremendous number of users, and can publish
- hundreds of virtual servers within the same process at the same time.
+Description: AOL web server version 4 - program files
+ AOLserver is the web engine that powers the America On-Line server. It
+ is capable of serving a very high number of users, and can host
+ simultaneously hundreds of virtual servers within the same process.
.
It is similar in many respects to Zope, except based largely on Tcl.
It is multi-threaded, and has a C API that can be used to extend
its functionality.
+ .
+ This package provides the core programs needed to run the server.
Package: aolserver4-core
Architecture: any
Depends: debconf (>= 1.2.9) | debconf-2.0, ${shlibs:Depends}, ${misc:Depends}
Provides: httpd, httpd-cgi
Recommends: aolserver4-doc
-Description: AOL Web Server 4 (Core libraries)
- This is the web engine that powers the mighty America On-Line. It
- is capable of serving a tremendous number of users, and can publish
- hundreds of virtual servers within the same process at the same time.
+Description: AOL web server version 4 - core libraries
+ AOLserver is the web engine that powers the America On-Line server. It
+ is capable of serving a very high number of users, and can host
+ simultaneously hundreds of virtual servers within the same process.
.
It is similar in many respects to Zope, except based largely on Tcl.
It is multi-threaded, and has a C API that can be used to extend
@@ -39,7 +41,7 @@
.
This package contains the basic shared libraries which are useful
for building add-on modules and are used also by the daemon.
- It does *not* contain the AOLserver daemon, which can be installed
+ It does not contain the AOLserver daemon, which can be installed
using aolserver4 package instead.
Package: aolserver4-dev
@@ -48,13 +50,17 @@
Depends: aolserver4-core (= ${binary:Version}), tcl-dev (>= 8.4), zlib1g-dev | libz-dev, ${misc:Depends}
Suggests: aolserver4-doc, aolserver4
Conflicts: aolserver4 (<< 4.5.1-1)
-Description: AOL Web Server 4 (Development Tools)
- This package includes the header files and static libraries needed
- to compile extensions and modules for AOLserver. The header files
- used to be part of the AOLserver package, but have been moved to
- this new package to reduce cruft on non-developer systems.
+Description: AOL web server version 4 - development files
+ AOLserver is the web engine that powers the America On-Line server. It
+ is capable of serving a very high number of users, and can host
+ simultaneously hundreds of virtual servers within the same process.
+ .
+ It is similar in many respects to Zope, except based largely on Tcl.
+ It is multi-threaded, and has a C API that can be used to extend
+ its functionality.
.
- This package contains version 4.x of AOLServer Development Tools.
+ This package contains header files and libraries needed to develop
+ applications based on AOLServer.
Package: aolserver4-doc
Section: doc
@@ -62,18 +68,25 @@
Depends: ${misc:Depends}
Recommends: www-browser
Suggests: aolserver4, tcl-doc
-Description: AOL Web Server 4 (Documentation)
- This package contains three reference manuals relating to AOLserver.
- The manuals document Version 3+ of AOLserver.
- .
- (1) The AOLserver Administrator's Guide covers the setup options
- and security issues relating to running the server.
- (2) The AOLserver Tcl Developer's Guide covers the Tcl API which
- can be used to add features to your web pages (similar in
- some respects to PHP or Microsoft's ASP)
- (3) The AOLserver C Developer's Guide covers the C API which can
- be used to create new modules to extend AOLserver.
+Description: AOL web server version 4 - documentation
+ AOLserver is the web engine that powers the America On-Line server. It
+ is capable of serving a very high number of users, and can host
+ simultaneously hundreds of virtual servers within the same process.
+ .
+ It is similar in many respects to Zope, except based largely on Tcl.
+ It is multi-threaded, and has a C API that can be used to extend
+ its functionality.
+ .
+ This package contains three reference manuals relating to the version
+ 3+ of AOLserver:
+ - The AOLserver Administrator's Guide covers the setup options
+ and security issues relating to running the server;
+ - The AOLserver Tcl Developer's Guide covers the Tcl API which
+ can be used to add features to your web pages (similar in
+ some respects to PHP or Microsoft's ASP);
+ - The AOLserver C Developer's Guide covers the C API which can
+ be used to create new modules to extend AOLserver.
.
This the latest available version of AOLServer documentation, but
- it is quite outdated and incomplete. Un up-to-date API documentation
- is available at http://panoptic.com/wiki/aolserver/Tcl_API
+ it is quite outdated and incomplete. An up-to-date API documentation
+ is available at http://panoptic.com/wiki/aolserver/Tcl_API.
Source: aolserver4
Section: web
Priority: optional
Maintainer: Francesco Paolo Lovergine <frankie@debian.org>
Build-Depends: sharutils, patch, debhelper (>= 7), tcl-dev (>= 8.4), dpatch, groff, zlib1g-dev
Standards-Version: 3.8.0
Homepage: http://www.aolserver.com/
Package: aolserver4
Architecture: any
Depends: aolserver4-core (= ${binary:Version}), debconf (>= 1.2.9) | debconf-2.0, mime-support, ucf (>= 0.30),
logrotate (>= 3.6.5-1), adduser, ${shlibs:Depends}, ${misc:Depends}
Provides: httpd, httpd-cgi
Recommends: aolserver4-doc
Conflicts: aolserver4-nscache
Replaces: aolserver4-nscache
Description: AOL web server version 4 - program files
AOLserver is the web engine that powers the America On-Line server. It
is capable of serving a very high number of users, and can host
simultaneously hundreds of virtual servers within the same process.
.
It is similar in many respects to Zope, except based largely on Tcl.
It is multi-threaded, and has a C API that can be used to extend
its functionality.
.
This package provides the core programs needed to run the server.
Package: aolserver4-core
Architecture: any
Depends: debconf (>= 1.2.9) | debconf-2.0, ${shlibs:Depends}, ${misc:Depends}
Provides: httpd, httpd-cgi
Recommends: aolserver4-doc
Description: AOL web server version 4 - core libraries
AOLserver is the web engine that powers the America On-Line server. It
is capable of serving a very high number of users, and can host
simultaneously hundreds of virtual servers within the same process.
.
It is similar in many respects to Zope, except based largely on Tcl.
It is multi-threaded, and has a C API that can be used to extend
its functionality.
.
This package contains the basic shared libraries which are useful
for building add-on modules and are used also by the daemon.
It does not contain the AOLserver daemon, which can be installed
using aolserver4 package instead.
Package: aolserver4-dev
Section: devel
Architecture: any
Depends: aolserver4-core (= ${binary:Version}), tcl-dev (>= 8.4), zlib1g-dev | libz-dev, ${misc:Depends}
Suggests: aolserver4-doc, aolserver4
Conflicts: aolserver4 (<< 4.5.1-1)
Description: AOL web server version 4 - development files
AOLserver is the web engine that powers the America On-Line server. It
is capable of serving a very high number of users, and can host
simultaneously hundreds of virtual servers within the same process.
.
It is similar in many respects to Zope, except based largely on Tcl.
It is multi-threaded, and has a C API that can be used to extend
its functionality.
.
This package contains header files and libraries needed to develop
applications based on AOLServer.
Package: aolserver4-doc
Section: doc
Architecture: all
Depends: ${misc:Depends}
Recommends: www-browser
Suggests: aolserver4, tcl-doc
Description: AOL web server version 4 - documentation
AOLserver is the web engine that powers the America On-Line server. It
is capable of serving a very high number of users, and can host
simultaneously hundreds of virtual servers within the same process.
.
It is similar in many respects to Zope, except based largely on Tcl.
It is multi-threaded, and has a C API that can be used to extend
its functionality.
.
This package contains three reference manuals relating to the version
3+ of AOLserver:
- The AOLserver Administrator's Guide covers the setup options
and security issues relating to running the server;
- The AOLserver Tcl Developer's Guide covers the Tcl API which
can be used to add features to your web pages (similar in
some respects to PHP or Microsoft's ASP);
- The AOLserver C Developer's Guide covers the C API which can
be used to create new modules to extend AOLserver.
.
This the latest available version of AOLServer documentation, but
it is quite outdated and incomplete. An up-to-date API documentation
is available at http://panoptic.com/wiki/aolserver/Tcl_API.
Attachment:
signature.asc
Description: Digital signature