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

Re: [RFR] templates://aolserver4/{aolserver4.templates}



Christian Perrier wrote:
> Your review should be sent as an answer to this mail.

(Those aolserver4-ns* modules do look like they need attention, but
first things first.)

>  Template: aolserver4/hostname
[...]
>  _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.

This still needs some work... for a start it's "a hostname" and
"redirect page URLs".  The second paragraph is better, though
"illegal" is a bit strong and there's a misplaced comma.

    AOLserver needs a hostname to use for redirect page URLs and for
    identifying itself.
    .
    It is generally the fully-qualified DNS hostname of the computer, or
    localhost if it is not networked. Any name valid for a URL string can
    be used.
 
>  Template: aolserver4/address
[...]
> +_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).

What's this "at least"?  Anything more is an invalid response...
Most of this seems redundant with the following paragraph.

> + It is not recommended to use the loopback address (127.0.0.1)
> + for use on a network.

Never mind "not recommended", loopback over a network isn't an
option.  I'd suggest:

    AOLserver needs an IP address to listen to.
    .
    The default is the address of the loopback interface. If the server
    is to be remotely accessible this should be replaced by the address
    of the appropriate network interface.

s/primary Ethernet interface/appropriate network interface/ because
it could be my gateway server's secondary wifi interface!

>  Package: aolserver4
[...]
> + 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.

s/the America On-Line server/America Online/ - though as a matter of
fact these days it's just "AOL" without an official expansion.

Also, make it "simultaneously within the same process".

>  Package: aolserver4-core
[...]
>   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.

That first paragraph has its priorities backwards, and the second is
largely redundant.  Merge them as:

    This package provides the basic shared libraries which are needed by
    the daemon and are also useful for building add-on modules. It does
    not contain the AOLserver daemon, which is in aolserver4.
  
>  Package: aolserver4-doc
[...]
> + This package contains three reference manuals relating to the version
> + 3+ of AOLserver:

That's still a bit awkward.

    This package contains three reference manuals for AOLserver version 3+:

>   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.

> Finally, correct spelling error: "Un" --> "An"...and add a dot at the
> end of the sentence....

I'd spotted s/this the/this is the/; I'd spotted the miscapitalised
"AOLServer" (I was thinking s/AOLServer/the/); I even noticed the
missing stop.  But I'd completely missed that "Un"!  Throw out the
"an"; or to hedge our bets, make it "More up-to-date"... so that's

    This is the latest available version of the documentation, but it is
    quite outdated and incomplete. More up-to-date API documentation is
    available at http://panoptic.com/wiki/aolserver/Tcl_API.         
-- 
JBR
Ankh kak! (Ancient Egyptian blessing)
--- ../aolserver4-4.5.1.pristine/debian/aolserver4.templates	2009-03-09 08:25:45.000000000 +0000
+++ debian/aolserver4.templates	2009-03-11 22:08:22.000000000 +0000
@@ -1,33 +1,29 @@
 Template: aolserver4/hostname
 Type: string
 Default: localhost
-_Description:  Server hostname:
- AOLserver server needs an hostname to be exposed on redirect pages URL and for
- informative purposes to identify itself.
+_Description: Server hostname:
+ AOLserver needs a hostname to use for redirect page URLs and for 
+ identifying 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.
+ It is generally the fully-qualified DNS hostname of the computer, or
+ localhost if it is not networked. Any name valid for a URL string can
+ be used.
 
 Template: aolserver4/address
 Type: string
 Default: 127.0.0.1
-_Description:  Server IP address number:
- 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).
+_Description: Server IP address:
+ AOLserver needs an IP address to listen to.
  .
- The default address is the loopback one, which is not recommended
- for general (network or Internet) use.
+ The default is the address of the loopback interface. If the server
+ is to be remotely accessible this should be replaced by the address
+ of the appropriate network interface.
 
 Template: aolserver4/port
 Type: string
 Default: 80
-_Description:  Server TCP port:
+_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.
- .
- It is recommended using the default.
- .
--- ../aolserver4-4.5.1.pristine/debian/control	2009-03-09 08:25:45.000000000 +0000
+++ debian/control	2009-03-11 22:29:14.000000000 +0000
@@ -14,33 +14,34 @@
 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 America Online. It
+ is capable of serving a very high number of users, and can host
+ hundreds of virtual servers simultaneously 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 America Online. It
+ is capable of serving a very high number of users, and can host
+ hundreds of virtual servers simultaneously 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.
+ This package provides the basic shared libraries which are needed by
+ the daemon and are also useful for building add-on modules. It does
+ not contain the AOLserver daemon, which is in aolserver4.
 
 Package: aolserver4-dev
 Section: devel
@@ -48,13 +49,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 America Online. It
+ is capable of serving a very high number of users, and can host
+ hundreds of virtual servers simultaneously 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 +67,24 @@
 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.
- .
- 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
+Description: AOL web server version 4 - documentation
+ AOLserver is the web engine that powers America Online. It
+ is capable of serving a very high number of users, and can host
+ hundreds of virtual servers simultaneously 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 for AOLserver version 3+:
+  - 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 is the latest available version of the documentation, but it is
+ quite outdated and incomplete. More up-to-date API documentation is
+ available at http://panoptic.com/wiki/aolserver/Tcl_API.
Template: aolserver4/hostname
Type: string
Default: localhost
_Description: Server hostname:
 AOLserver needs a hostname to use for redirect page URLs and for 
 identifying itself.
 .
 It is generally the fully-qualified DNS hostname of the computer, or
 localhost if it is not networked. Any name valid for a URL string can
 be used.

Template: aolserver4/address
Type: string
Default: 127.0.0.1
_Description: Server IP address:
 AOLserver needs an IP address to listen to.
 .
 The default is the address of the loopback interface. If the server
 is to be remotely accessible this should be replaced by the address
 of the appropriate network interface.

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.
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 America Online. It
 is capable of serving a very high number of users, and can host
 hundreds of virtual servers simultaneously 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 America Online. It
 is capable of serving a very high number of users, and can host
 hundreds of virtual servers simultaneously 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 basic shared libraries which are needed by
 the daemon and are also useful for building add-on modules. It does
 not contain the AOLserver daemon, which is in aolserver4.

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 America Online. It
 is capable of serving a very high number of users, and can host
 hundreds of virtual servers simultaneously 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 America Online. It
 is capable of serving a very high number of users, and can host
 hundreds of virtual servers simultaneously 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 for AOLserver version 3+:
  - 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 is the latest available version of the documentation, but it is
 quite outdated and incomplete. More up-to-date API documentation is
 available at http://panoptic.com/wiki/aolserver/Tcl_API.

Reply to: