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

Re: [LCFC] templates://apt-cacher-ng/{apt-cacher-ng.templates}



Christian PERRIER wrote:
> This is the last call for comments for the review of debconf
> templates for apt-cacher-ng.

Sorry, I somehow missed the RFR for this!  But I remember reading the
package description and seeing nothing I would change there, so for
once I can't blame Gmail.

> Template: apt-cacher-ng/gentargetmode
[...]
>  Apt-Cacher NG can download packages from repositories other than those
>  requested by the clients. This allows it to cache content effectively,
>  and makes it easy for an administrator to switch to another mirror later.
>  .
>  This remapping of URLs can be configured now in an automated way based on the
>  current state of /etc/apt/sources.list. Optionally, this process can be
>  repeated on every package update (modifying the configuration files each
>  time).
>  .
>  Selecting "No automated setup" will leave the existing configuration
>  unchanged. It will need to be updated manually.
 
The confusing part is that this tells the admin about two lots of
things AC-NG "can" do without making it immediately obvious that we're
asking for input on whether it should do the _second_ thing.  It's not:

   Please specify whether Apt-Cacher NG should download packages [...]

It's:

   Apt-Cacher NG can download packages [...]
   .
   Please specify whether this remapping of URLs should be configured [...]

But that approach gives a badly overstretched sentence in the second
paragraph.  How about splitting it slightly differently:

   Apt-Cacher NG can download packages from repositories other than those
   requested by the clients. This allows it to cache content effectively,
   and makes it easy for an administrator to switch to another mirror later.
   The URL remapping can be set up automatically, using a configuration
   based on the current state of /etc/apt/sources.list.
   .
   Please specify whether the remapping should be configured once now, or
   reconfigured on every update of Apt-Cacher NG (modifying the
   configuration files each time), or left unconfigured.
   .
   Selecting "No automated setup" will leave the existing configuration
   unchanged. It will need to be updated manually.

> Template: apt-cacher-ng/bindaddress
> Type: string
> Default: keep
> _Description: Address(es) for apt-cacher-ng to listen to:

Wait, it doesn't listen *to* these addresses.  They're local network
interfaces that it listens *on*.  And shouldn't it be "Apt-Cacher NG"?

Perhaps to match the following prompt:
   _Description: Listening address(es) for Apt-Cacher-NG:

>  Please enter the addresses or hostnames which should be used by
>  apt-cacher-ng (multiple entries must be separated by spaces).

Make that

   Please specify the local addresses that Apt-Cacher NG should listen on
   (multiple entries must be separated by spaces).

>  .
>  Each entry must be an exact address (IP or hostname) which is
>  associated with a local network interface. Generic protocol specific addresses
>  are supported, such as 0.0.0.0 for listening on all IPv4 enabled interfaces.

I don't like "an exact address (IP or hostname)" - for a start, how
would an interface's IP address be anything but "exact"?  Asking for
an "exact" hostname sounds as if it wants the FQDN.  And it turns out
that it's happy to accept 0.0.0.0, which hardly seems very "exact".

Besides which, there's no such thing as an IP.  Just say:

   Each entry must be an IP address or hostname associated with a local
   network interface. Generic protocol-specific addresses are also
   supported, such as 0.0.0.0 for listening on all IPv4-enabled interfaces.

(Note added hyphens.)

>  .
>  If this field is left empty, apt-cacher-ng wille listen on all
>  interfaces, with all supported protocols.

Typo.

>  .
>  The special word "keep" keeps the value from the current (or default)
>  configuration unchanged.
> 
> Template: apt-cacher-ng/port
> Type: string
> Default: keep
> _Description: Listening TCP port:
>  Please configure the TCP port where Apt-Cacher NG should listen for incoming HTTP
>  (proxy) requests. The default value is port 3142, and it can be set to 9999 to emulate
>  apt-proxy.

I don't like the "where".  Or the "and".

   Please specify the TCP port that Apt-Cacher NG should listen on for
   incoming HTTP (proxy) requests. The default value is port 3142, but it
   can be set to 9999 to emulate apt-proxy.

>  .
>  If left empty, the value from the current configuration remains unchanged.

Make that "If this field is left empty" again.
 
> Template: apt-cacher-ng/cachedir
> Type: string
> Default: keep
> _Description: Top level directory for packages cache:
                                               ^
I probably wouldn't add plural marking in this noun stack.  And while
I'm here I'll add a hyphen to "top-level". 

>  The main cache storage directory should be located on a file system without
>  file name restrictions.

No "Please specify"?  Well, it makes a change, I suppose.

(A file with a name consisting of a billion nulls is going to be
unwelcome more or less anywhere, but let's assume the word "relevant"
is implied here.)

>  .
>  If left empty, the value from the current configuration remains unchanged or
>  is set to default directory /var/cache/apt-cacher-ng.

   If this field is left empty, the value from the current configuration
   remains unchanged or is set to the default of /var/cache/apt-cacher-ng.
 
> Template: apt-cacher-ng/proxy
> Type: string
> Default: keep
> _Description: Proxy to use for downloads:
>  Please specify the proxy server to use for downloads.
>  .
>  Username and password for the proxy server can be included here following the
>  user:pass@host:port scheme. However, please check the documentation for limitations.
>  .
>  If this field is left empty, apt-cacher NG will not use any proxy
>  server.
>  .
>  The special word "keep" keeps the value from the current (or default)
>  configuration unchanged.

Just s/ac-NG/AC-NG/.
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
diff -ru apt-cacher-ng-0.7.24.pristine/debian/apt-cacher-ng.templates apt-cacher-ng-0.7.24/debian/apt-cacher-ng.templates
--- apt-cacher-ng-0.7.24.pristine/debian/apt-cacher-ng.templates	2013-12-19 19:53:46.000000000 +0000
+++ apt-cacher-ng-0.7.24/debian/apt-cacher-ng.templates	2014-01-20 12:15:33.810269068 +0000
@@ -15,11 +15,12 @@
  Apt-Cacher NG can download packages from repositories other than those
  requested by the clients. This allows it to cache content effectively,
  and makes it easy for an administrator to switch to another mirror later.
+ The URL remapping can be set up automatically, using a configuration
+ based on the current state of /etc/apt/sources.list.
  .
- This remapping of URLs can be configured now in an automated way based on the
- current state of /etc/apt/sources.list. Optionally, this process can be
- repeated on every package update (modifying the configuration files each
- time).
+ Please specify whether the remapping should be configured once now, or
+ reconfigured on every update of Apt-Cacher NG (modifying the
+ configuration files each time), or left unconfigured.
  .
  Selecting "No automated setup" will leave the existing configuration
  unchanged. It will need to be updated manually.
@@ -27,12 +28,16 @@
 Template: apt-cacher-ng/bindaddress
 Type: string
 Default: keep
-_Description: Bind Address(es):
- Addresses or hostnames to listen on, multiple entries must be separated
- by spaces. Each entry must be an exact address (IP or hostname) which is
- associated with a local network interface. Generic protocol specific addresses
- are supported, like 0.0.0.0 for listening on all IPv4 enabled interfaces.
- Leaving this empty (the default setting) means listening on all interfaces and protocols.
+_Description: Listening address(es) for Apt-Cacher NG:
+ Please specify the local addresses that Apt-Cacher NG should listen on
+ (multiple entries must be separated by spaces).
+ .
+ Each entry must be an IP address or hostname associated with a local
+ network interface. Generic protocol-specific addresses are also
+ supported, such as 0.0.0.0 for listening on all IPv4-enabled interfaces.
+ .
+ If this field is left empty, Apt-Cacher NG will listen on all
+ interfaces, with all supported protocols.
  .
  The special word "keep" keeps the value from the current (or default)
  configuration unchanged.
@@ -41,30 +46,34 @@
 Type: string
 Default: keep
 _Description: Listening TCP port:
- Configure at which TCP port should Apt-Cacher NG listen for incoming HTTP
- (proxy) requests. Default is port 3142, and it can be set to 9999 to emulate
- apt-proxy.
+ Please specify the TCP port that Apt-Cacher NG should listen on for
+ incoming HTTP (proxy) requests. The default value is port 3142, but it
+ can be set to 9999 to emulate apt-proxy.
  .
- If left empty, the value from the current configuration remains unchanged.
+ If this field is left empty, the value from the current configuration
+ remains unchanged.
 
 Template: apt-cacher-ng/cachedir
 Type: string
 Default: keep
-_Description: Top level directory for package cache:
+_Description: Top-level directory for package cache:
  The main cache storage directory should be located on a file system without
  file name restrictions.
  .
- If left empty, the value from the current configuration remains unchanged or
- is set to default directory /var/cache/apt-cacher-ng.
+ If this field is left empty, the value from the current configuration
+ remains unchanged or is set to the default of /var/cache/apt-cacher-ng.
 
 Template: apt-cacher-ng/proxy
 Type: string
 Default: keep
 _Description: Proxy to use for downloads:
- The specification of another proxy which shall be used for downloads.
+ Please specify the proxy server to use for downloads.
+ .
  Username and password for the proxy server can be included here following the
- user:pass@host:port scheme but see the manual for limitations. If set to
- empty, direct connection is used.
+ user:pass@host:port scheme. However, please check the documentation for limitations.
+ .
+ If this field is left empty, Apt-Cacher NG will not use any proxy
+ server.
  .
  The special word "keep" keeps the value from the current (or default)
  configuration unchanged.
# These templates have been reviewed by the debian-l10n-english
# team
#
# If modifications/additions/rewording are needed, please ask
# debian-l10n-english@lists.debian.org for advice.
#
# Even minor modifications require translation updates and such
# changes should be coordinated with translators and reviewers.

Template: apt-cacher-ng/gentargetmode
Type: select
__Choices: Set up once, Set up now and update later, No automated setup
Default: Set up once
_Description: Automatic remapping of client requests:
 Apt-Cacher NG can download packages from repositories other than those
 requested by the clients. This allows it to cache content effectively,
 and makes it easy for an administrator to switch to another mirror later.
 The URL remapping can be set up automatically, using a configuration
 based on the current state of /etc/apt/sources.list.
 .
 Please specify whether the remapping should be configured once now, or
 reconfigured on every update of Apt-Cacher NG (modifying the
 configuration files each time), or left unconfigured.
 .
 Selecting "No automated setup" will leave the existing configuration
 unchanged. It will need to be updated manually.

Template: apt-cacher-ng/bindaddress
Type: string
Default: keep
_Description: Listening address(es) for Apt-Cacher NG:
 Please specify the local addresses that Apt-Cacher NG should listen on
 (multiple entries must be separated by spaces).
 .
 Each entry must be an IP address or hostname associated with a local
 network interface. Generic protocol-specific addresses are also
 supported, such as 0.0.0.0 for listening on all IPv4-enabled interfaces.
 .
 If this field is left empty, Apt-Cacher NG will listen on all
 interfaces, with all supported protocols.
 .
 The special word "keep" keeps the value from the current (or default)
 configuration unchanged.

Template: apt-cacher-ng/port
Type: string
Default: keep
_Description: Listening TCP port:
 Please specify the TCP port that Apt-Cacher NG should listen on for
 incoming HTTP (proxy) requests. The default value is port 3142, but it
 can be set to 9999 to emulate apt-proxy.
 .
 If this field is left empty, the value from the current configuration
 remains unchanged.

Template: apt-cacher-ng/cachedir
Type: string
Default: keep
_Description: Top-level directory for package cache:
 The main cache storage directory should be located on a file system without
 file name restrictions.
 .
 If this field is left empty, the value from the current configuration
 remains unchanged or is set to the default of /var/cache/apt-cacher-ng.

Template: apt-cacher-ng/proxy
Type: string
Default: keep
_Description: Proxy to use for downloads:
 Please specify the proxy server to use for downloads.
 .
 Username and password for the proxy server can be included here following the
 user:pass@host:port scheme. However, please check the documentation for limitations.
 .
 If this field is left empty, Apt-Cacher NG will not use any proxy
 server.
 .
 The special word "keep" keeps the value from the current (or default)
 configuration unchanged.
Source: apt-cacher-ng
Section: net
Priority: optional
Maintainer: Eduard Bloch <blade@debian.org>
Build-Depends: debhelper (>= 9), cmake (>= 2.6.2), libbz2-dev, zlib1g-dev, liblzma-dev, libfuse-dev [!hurd-i386], pkg-config, libwrap0-dev, lsb-base (>> 3.0-6), dh-systemd (>= 1.5), po-debconf, libssl-dev
Standards-Version: 3.9.5
Homepage: http://www.unix-ag.uni-kl.de/~bloch/acng/

Package: apt-cacher-ng
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, adduser
Pre-Depends: dpkg (>= 1.15.6)
Recommends: ed, avahi-daemon
Conflicts: logrotate (<< 3.8.0)
Suggests: doc-base, libfuse2 (>= 2.5), curl | wget
Description: caching proxy server for software repositories
 Apt-Cacher NG is a caching proxy for downloading packages from Debian-style
 software repositories (or possibly from other types).
 .
 The main principle is that a central machine hosts the proxy for a local
 network, and clients configure their APT setup to download through it.
 Apt-Cacher NG keeps a copy of all useful data that passes through it, and when
 a similar request is made, the cached copy of the data is delivered without
 being re-downloaded.
 .
 Apt-Cacher NG has been designed from scratch as a replacement for
 apt-cacher, but with a focus on maximizing throughput with low system
 resource requirements. It can also be used as replacement for apt-proxy and
 approx with no need to modify clients' sources.list files.

Reply to: