Please find, for review, the debconf templates and packages descriptions for the webfs source package.
This review will last from Wednesday, February 24, 2010 to Saturday, March 06, 2010.
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:
--- webfs.old/debian/templates 2010-01-29 10:53:29.000000000 +0100
+++ webfs/debian/templates 2010-02-20 14:37:55.376998069 +0100
@@ -1,14 +1,14 @@
Template: webfsd/web_ip
Type: string
-_Description: IP address webfsd should listen on:
- If your box has more than one IP address, you can pick one here for webfsd.
- Leaving this field blank will allow webfsd to listen on all IP addresses.
+_Description: IP address webfsd should listen to:
+ When multiple IP addresses are used, webfsd can be configured to
+ listen to only one of them.
+ .
+ If you leave this empty, webfsd will listen to all IP addresses.
I'm not really sure here. "listen on" or "listen to"?
Avoid "your box". Too trivial language...and the "box" is not
necessarily "mine".
Template: webfsd/web_timeout
Type: string
_Description: Timeout for network connections:
- The default timeout is 60 seconds. You can pick another value here if you
- want.
The long description is useless. The default value will appear in the
field.....and it is fairly obvious that one can change it..:-)
Template: webfsd/pending
Type: string
@@ -18,51 +18,49 @@
Template: webfsd/web_conn
Type: string
_Description: Number of parallel network connections:
- By default, webfsd allows 32 network connections. For private/small
- networks, the default should be fine. If you are running a big server, you
- probably want to use a higher number.
+ For private and small
+ networks, the default number of parallel network connections should
+ be fine. This can be increased for larger networks.
Same remark for the default value.
Template: webfsd/web_dircache
Type: string
_Description: Directory cache size:
- webfsd can keep cached directory listings. By default, the size of
- the cache is limited to 128 entries. If you have a very big
- directory tree, you might want to raise this value.
+ Directory listings can be cached by webfsd. By default, the size of
+ the cache is limited to 128 entries. If the web server has
+ very big directory trees, you might want to raise this value.
Avoid leading lowercase letter byt using passive form.
"I" don't have a big tree (actually, I have one, but it is in my
garden)...but my web server has one..:-)
Template: webfsd/web_port
Type: string
-_Description: Port number webfsd should listen on:
- By default, webfsd listens on port 8000. If you want to use another port, enter
- it here.
+_Description: Incoming port number for webfsd:
Same remark than above.
Template: webfsd/web_virtual
Type: boolean
Default: false
-_Description: Should virtual host support be enabled?
+_Description: Enable virtual host?
Please choose this option if you want webfsd support name-based
- virtual hosts. The first directory level below your document root
+ virtual hosts. The first directory level below the web server's document root
will then be used as hostname.
Avoid double spaces.
Not "my" document root...
Template: webfsd/web_root
Type: string
Default: /var/ftp
_Description: Document root for webfsd:
- webfsd is a lightweight HTTP server which only serves static files. You
- can use it for example to provide HTTP access to your anonymous FTP
- server.
+ Webfsd is a lightweight HTTP server which only serves static files.
+ That may be useful to provide basic HTTP access to an anonymous FTP
+ server, for instance.
.
- You need to specify the document root for the webfs daemon, i.e. the
- directory tree which will be exported.
+ Please specify the document root for the webfs daemon.
.
- Leave this blank if you don't want webfsd started by the system at boot time.
+ If you leave this field blank, webfsd will not be started at boot time.
I couldn't find a way to not start by "webfsd". Capitalize it anyway.
Reformulations to better fit the writing style used in other packages.
Template: webfsd/web_host
Type: string
_Description: Host name for webfsd:
- webfsd will use the machine's hostname by default. If this box has an alias
- name (like ftp.domain.org) which should be visible outside instead of the
- real hostname (say debian.domain.org), then enter this name here.
- Otherwise you can leave this blank.
+ By default, webfsd uses the machine name as hostname.
+ .
+ You can specify an alternate host name to be used as an external
+ alias name (for instance "ftp.example.org") instead of the machine's
+ fully qualified domain name.
(use the standard example domain name instead of a faked one)
Template: webfsd/web_user
Type: string
@@ -72,13 +70,15 @@
Template: webfsd/web_syslog
Type: boolean
Default: false
-_Description: Should webfsd log events (start/stop/...) to syslog?
+_Description: Log webfsd events (start/stop/...) to syslog?
Though the original seems correct, I found it strange and preferred a
small simplification.
Template: webfsd/web_accesslog
Type: string
_Description: Access log file:
- webfsd can write an access log in common log format. If you want this,
- enter the log file name here. By default, no logfile will be written.
+ Accesses to webfsd can be logged in common log format.
+ .
+ If this field is left empty, no logging of incomming connections will
+ be done.
Split in two paragraphs.
Make it clearer that leaving the field empty means 'no logging'. OTOH
no need to repeat that a file name is expected here. The synopsis says
it clearly.
Template: webfsd/web_logbuffering
Type: boolean
@@ -96,22 +96,30 @@
Type: string
_Description: Directory index filename:
If webfsd receives a request for a directory, it can optionally look for an
- index file it should send to the client. Common names are index.html and
- default.html. If you want this, enter the filename here. If you leave it
- blank or no such file exists, webfsd will send a directory listing to the
+ index file it should send to the client. Common names are "index.html" and
+ "default.html".
+ .
+ If you leave this field empty, webfsd will send a directory listing to the
client.
Quote file names.
Split in two paragraphs to make it clear that leaving this empty
disables the feature.
Template: webfsd/web_cgipath
Type: string
_Description: CGI script catalog:
- If webfsd shall be able to deliver output from CGI functions, their
- location must be declared. The path must begin immediately below
- the document root and be specified with an initial slash. An empty
- path disables this feature.
+ Please specify the location for CGI scripts served by webfsd. This
+ path should be located immediately below
+ the document root.
+ .
+ Please specify the full path name and not a relative path. If this
+ field is left empty, CGI scripts will be disabled.
Pretty much the same rationale than above.
Template: webfsd/web_extras
Type: string
_Description: Extra options to include:
- Webfsd has further capacities that were not mentioned above, such as
- chrooted service, timed expiration of files, and locked binding to
- either IPv6 or IPv4. Consult the manual page and add any extras here.
+ Please specify any webfsd option you want to use with the main
+ daemon.
+ .
+ This allows, for instance, to specify the use of a chrooted service,
+ timed expiration of files, and locked binding to
+ either IPv6 or IPv4.
+ .
+ Please check webfsd manual page for more details.
Split in paragraphs and reformulate.
--- webfs.old/debian/control 2010-02-03 21:27:50.000000000 +0100
+++ webfs/debian/control 2010-02-20 14:40:11.580999397 +0100
@@ -10,10 +10,12 @@
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, debconf | debconf-2.0
Provides: httpd
-Description: lightweight http server for static content
- This is a simple http server for mostly static content. You
- can use it to serve the content of a ftp server via http for
- example. It is also nice to export some files the quick way
- by starting a http server in a few seconds, without editing
- some config file first. Limited cgi support (GET requests
- only) has been added recently.
+Description: lightweight HTTP server for static content
+ This package provides a simple HTTP server for static content.
+ .
+ It can be used for instance to serve the content of an FTP server via
+ HTTP.
+ It also allows a quick and painless setup of an HTTP server, without editing
+ configuration files first.
+ .
+ Webfsd also includes some limited CGI support, only for GET requests.
"This is" is highly discouraged in package descriptions. Split in paragraphs.
--
Template: webfsd/web_ip Type: string _Description: IP address webfsd should listen to: When multiple IP addresses are used, webfsd can be configured to listen to only one of them. . If you leave this empty, webfsd will listen to all IP addresses. Template: webfsd/web_timeout Type: string _Description: Timeout for network connections: Template: webfsd/pending Type: string Default: no Description: for internal use only Template: webfsd/web_conn Type: string _Description: Number of parallel network connections: For private and small networks, the default number of parallel network connections should be fine. This can be increased for larger networks. Template: webfsd/web_dircache Type: string _Description: Directory cache size: Directory listings can be cached by webfsd. By default, the size of the cache is limited to 128 entries. If the web server has very big directory trees, you might want to raise this value. Template: webfsd/web_port Type: string _Description: Incoming port number for webfsd: Template: webfsd/web_virtual Type: boolean Default: false _Description: Enable virtual host? Please choose this option if you want webfsd support name-based virtual hosts. The first directory level below the web server's document root will then be used as hostname. Template: webfsd/web_root Type: string Default: /var/ftp _Description: Document root for webfsd: Webfsd is a lightweight HTTP server which only serves static files. That may be useful to provide basic HTTP access to an anonymous FTP server, for instance. . Please specify the document root for the webfs daemon. . If you leave this field blank, webfsd will not be started at boot time. Template: webfsd/web_host Type: string _Description: Host name for webfsd: By default, webfsd uses the machine name as hostname. . You can specify an alternate host name to be used as an external alias name (for instance "ftp.example.org") instead of the machine's fully qualified domain name. Template: webfsd/web_user Type: string Default: www-data _Description: User running the webfsd daemon: Template: webfsd/web_syslog Type: boolean Default: false _Description: Log webfsd events (start/stop/...) to syslog? Template: webfsd/web_accesslog Type: string _Description: Access log file: Accesses to webfsd can be logged in common log format. . If this field is left empty, no logging of incomming connections will be done. Template: webfsd/web_logbuffering Type: boolean Default: true _Description: Should logging be buffered? With buffered logging, entries will be written in chunks, not as soon as they are registered as client calls. Template: webfsd/web_group Type: string Default: www-data _Description: Group running the webfsd daemon: Template: webfsd/web_index Type: string _Description: Directory index filename: If webfsd receives a request for a directory, it can optionally look for an index file it should send to the client. Common names are "index.html" and "default.html". . If you leave this field empty, webfsd will send a directory listing to the client. Template: webfsd/web_cgipath Type: string _Description: CGI script catalog: Please specify the location for CGI scripts served by webfsd. This path should be located immediately below the document root. . Please specify the full path name and not a relative path. If this field is left empty, CGI scripts will be disabled. Template: webfsd/web_extras Type: string _Description: Extra options to include: Please specify any webfsd option you want to use with the main daemon. . This allows, for instance, to specify the use of a chrooted service, timed expiration of files, and locked binding to either IPv6 or IPv4. . Please check webfsd manual page for more details.
--- webfs.old/debian/templates 2010-01-29 10:53:29.000000000 +0100
+++ webfs/debian/templates 2010-02-24 22:43:03.240200592 +0100
@@ -1,14 +1,14 @@
Template: webfsd/web_ip
Type: string
-_Description: IP address webfsd should listen on:
- If your box has more than one IP address, you can pick one here for webfsd.
- Leaving this field blank will allow webfsd to listen on all IP addresses.
+_Description: IP address webfsd should listen to:
+ When multiple IP addresses are used, webfsd can be configured to
+ listen to only one of them.
+ .
+ If you leave this empty, webfsd will listen to all IP addresses.
Template: webfsd/web_timeout
Type: string
_Description: Timeout for network connections:
- The default timeout is 60 seconds. You can pick another value here if you
- want.
Template: webfsd/pending
Type: string
@@ -18,51 +18,49 @@
Template: webfsd/web_conn
Type: string
_Description: Number of parallel network connections:
- By default, webfsd allows 32 network connections. For private/small
- networks, the default should be fine. If you are running a big server, you
- probably want to use a higher number.
+ For private and small
+ networks, the default number of parallel network connections should
+ be fine. This can be increased for larger networks.
Template: webfsd/web_dircache
Type: string
_Description: Directory cache size:
- webfsd can keep cached directory listings. By default, the size of
- the cache is limited to 128 entries. If you have a very big
- directory tree, you might want to raise this value.
+ Directory listings can be cached by webfsd. By default, the size of
+ the cache is limited to 128 entries. If the web server has
+ very big directory trees, you might want to raise this value.
Template: webfsd/web_port
Type: string
-_Description: Port number webfsd should listen on:
- By default, webfsd listens on port 8000. If you want to use another port, enter
- it here.
+_Description: Incoming port number for webfsd:
Template: webfsd/web_virtual
Type: boolean
Default: false
-_Description: Should virtual host support be enabled?
+_Description: Enable virtual host?
Please choose this option if you want webfsd support name-based
- virtual hosts. The first directory level below your document root
+ virtual hosts. The first directory level below the web server's document root
will then be used as hostname.
Template: webfsd/web_root
Type: string
Default: /var/ftp
_Description: Document root for webfsd:
- webfsd is a lightweight HTTP server which only serves static files. You
- can use it for example to provide HTTP access to your anonymous FTP
- server.
+ Webfsd is a lightweight HTTP server which only serves static files.
+ That may be useful to provide basic HTTP access to an anonymous FTP
+ server, for instance.
.
- You need to specify the document root for the webfs daemon, i.e. the
- directory tree which will be exported.
+ Please specify the document root for the webfs daemon.
.
- Leave this blank if you don't want webfsd started by the system at boot time.
+ If you leave this field blank, webfsd will not be started at boot time.
Template: webfsd/web_host
Type: string
_Description: Host name for webfsd:
- webfsd will use the machine's hostname by default. If this box has an alias
- name (like ftp.domain.org) which should be visible outside instead of the
- real hostname (say debian.domain.org), then enter this name here.
- Otherwise you can leave this blank.
+ By default, webfsd uses the machine name as hostname.
+ .
+ You can specify an alternate host name to be used as an external
+ alias name (for instance "ftp.example.org") instead of the machine's
+ fully qualified domain name.
Template: webfsd/web_user
Type: string
@@ -72,13 +70,15 @@
Template: webfsd/web_syslog
Type: boolean
Default: false
-_Description: Should webfsd log events (start/stop/...) to syslog?
+_Description: Log webfsd events (start/stop/...) to syslog?
Template: webfsd/web_accesslog
Type: string
_Description: Access log file:
- webfsd can write an access log in common log format. If you want this,
- enter the log file name here. By default, no logfile will be written.
+ Accesses to webfsd can be logged in common log format.
+ .
+ If this field is left empty, no logging of incomming connections will
+ be done.
Template: webfsd/web_logbuffering
Type: boolean
@@ -96,22 +96,30 @@
Type: string
_Description: Directory index filename:
If webfsd receives a request for a directory, it can optionally look for an
- index file it should send to the client. Common names are index.html and
- default.html. If you want this, enter the filename here. If you leave it
- blank or no such file exists, webfsd will send a directory listing to the
+ index file it should send to the client. Common names are "index.html" and
+ "default.html".
+ .
+ If you leave this field empty, webfsd will send a directory listing to the
client.
Template: webfsd/web_cgipath
Type: string
_Description: CGI script catalog:
- If webfsd shall be able to deliver output from CGI functions, their
- location must be declared. The path must begin immediately below
- the document root and be specified with an initial slash. An empty
- path disables this feature.
+ Please specify the location for CGI scripts served by webfsd. This
+ path should be located immediately below
+ the document root.
+ .
+ Please specify the full path name and not a relative path. If this
+ field is left empty, CGI scripts will be disabled.
Template: webfsd/web_extras
Type: string
_Description: Extra options to include:
- Webfsd has further capacities that were not mentioned above, such as
- chrooted service, timed expiration of files, and locked binding to
- either IPv6 or IPv4. Consult the manual page and add any extras here.
+ Please specify any webfsd option you want to use with the main
+ daemon.
+ .
+ This allows, for instance, to specify the use of a chrooted service,
+ timed expiration of files, and locked binding to
+ either IPv6 or IPv4.
+ .
+ Please check webfsd manual page for more details.
--- webfs.old/debian/control 2010-02-03 21:27:50.000000000 +0100
+++ webfs/debian/control 2010-02-20 14:40:11.580999397 +0100
@@ -10,10 +10,12 @@
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, debconf | debconf-2.0
Provides: httpd
-Description: lightweight http server for static content
- This is a simple http server for mostly static content. You
- can use it to serve the content of a ftp server via http for
- example. It is also nice to export some files the quick way
- by starting a http server in a few seconds, without editing
- some config file first. Limited cgi support (GET requests
- only) has been added recently.
+Description: lightweight HTTP server for static content
+ This package provides a simple HTTP server for static content.
+ .
+ It can be used for instance to serve the content of an FTP server via
+ HTTP.
+ It also allows a quick and painless setup of an HTTP server, without editing
+ configuration files first.
+ .
+ Webfsd also includes some limited CGI support, only for GET requests.
Source: webfs
Section: httpd
Priority: optional
Build-Depends: debhelper (>= 7), po-debconf
Maintainer: Mats Erik Andersson <mats.andersson@gisladisker.se>
Standards-Version: 3.8.4
Homepage: http://linux.bytesex.org/misc/webfs.html
Package: webfs
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, debconf | debconf-2.0
Provides: httpd
Description: lightweight HTTP server for static content
This package provides a simple HTTP server for static content.
.
It can be used for instance to serve the content of an FTP server via
HTTP.
It also allows a quick and painless setup of an HTTP server, without editing
configuration files first.
.
Webfsd also includes some limited CGI support, only for GET requests.
Attachment:
signature.asc
Description: Digital signature