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

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



Please find, for review, the debconf templates of apt-cacher-ng.

This review will last from Thursday, May 28, 2009 to Sunday, June 07, 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 reach a consensus, I will 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:

--- ../apt-cacher-ng.old/debian/apt-cacher-ng.templates	2009-05-27 20:37:13.000000000 +0100
+++ debian/apt-cacher-ng.templates	2009-05-28 22:48:07.000000000 +0100
@@ -1,20 +1,18 @@
 Template: apt-cacher-ng/modifytargets
 Type: boolean
 Default: true
-_Description: Configure apt-cacher-ng to transparently reroute requests to different mirrors?
- Apt-cacher-ng can silently and transparently reroute user requests to
- different mirror(s). To simplify required configuration this setup can create
- or modify lists of target hosts.
+_Description: Transparently divert requests?

The description was far too long. This brevity turns it into a much more
elegant question

+ If enabled, apt-cacher-ng will request packages from a mirror of your
+ choosing, instead of the one requested by the client. If disabled, the
+ client's request will be respected.
+ .
+ You can choose how this feature should behave in the next step.

As it's a boolean, we just need a simple yes or no. Split the paragraph
to make it easier to read.

This next bit is a big change and needs the maintainers input because
it's going to affect the postinst scripts:
 
 Template: apt-cacher-ng/gentargetmode
-Type: select
-_Choices: Create once, Create now and update later, Disable target rerouting
-_Default: Create once
-_Description: Configuration mode of download sources:
- The lists of target mirrors (download sources) for popular distributions can
- be created based on information in the current sources.list file. Optionally,
- the lists can be updated to match sources.list on every later update of the
- apt-cacher-ng package.
- .
- Alternatively, the target mirror rerouting can be disabled now by removing the
- current targets from existing lists.
+Type: boolean

It doesn't make any sense asking the user whether to enable re-routing,
and then effective ask again in the next question. So, since there are
then only two options, a boolean is much more appropriate (a simple
should-it-be-automatic choice is more logical, I think).

This obviously changes the maintainer script quite a lot. Eduard,
are you happy to make a change this big? For the purposes of this RFR,
I'll assume so, but please indicate your preference one way or the
other.

+Default: true
+_Description: Update the mirror list automatically?

Change the question to fit this new type.

+ A seperate mirror list is kept by apt-cacher-ng, which starts as a copy of
+ /etc/apt/sources.list. If you enable this option, the mirror list will
+ be copied again each time apt-cacher-ng is updated. This ensures that
+ if you change APT's list in the future, apt-cacher-ng reflects this.

As it's now a boolean, make this a nice straighforward choice between
enabling continuing updates, and just leaving the sources list as is.

--- ../apt-cacher-ng.old/debian/control	2009-05-27 20:37:13.000000000 +0100
+++ debian/control	2009-05-28 22:31:21.000000000 +0100
@@ -9,20 +9,20 @@
 Architecture: any
 Depends: ${shlibs:Depends}, ${misc:Depends}, adduser
 Recommends: perl (>> 5.8), ed
-Description: Caching proxy for distribution of software packages
- Apt-Cacher NG is yet another implementation of a HTTP proxy for
- software packages, primarily targeted at Debian/Ubuntu packages but
- may also be used with others types.
+Description: caching proxy for distribution of software packages

Lose the capital letter so that it's in is-a form.

+ Apt-Cacher NG is yet another implementation of an HTTP proxy for

'an'

+ software packages. It is primarily designed for .deb packages but
+ may also be used with other package types.

Break the sentence up a bit. Lots of other distributions besides us and
Ubuntu use the .deb package format. Grammar in the last line.

  .
- It follows similar principles as others (Apt-Cacher, Apt-Proxy, 
- Approx) and serves the same purpose: a central machine presents the
+ It follows principles similar to many other solutions
+ and serves the same purpose: a central machine presents the

The principles bit - as usual, I can't explain it in linguistic terms,
but this is a better form of the sentence.

'similar to', not 'as'.

Remove the names of other packages; there's no guarantee they'll be
around forever.

  proxy for a local network and clients configure their APT setup
- to download through it. Apt-Cacher keeps a copy of all useful data
- that has been passed through it and when a similar request appears,
- the old copy of the data is delivered without redownloading it from
- the Debian mirrors.
+ 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 fetching it from
+ the repository all over again.

Make the package's name consistent. Avoid mixing tenses, and avoid use
of 'redownloading' (I don't know if it's even a word). Avoid implying
that the cached data will be out-of-date by the time it reaches the
second client. Since earlier we've asserted that apt-cacher-ng will
handle other package types, make the repository neutral instead of
calling it a Debian mirror.

  .
- Apt-Cacher NG is more than a simple rewrite of Apt-Cacher. It was redesigned
- from scratch and is written in C++ with main focus on maximizing throughput
+ Apt-Cacher NG has been designed
+ from scratch with a focus on maximizing throughput
  with low requirements on system resources. 

With my user's hat on, I don't really care what language it's written in
or what it's history is. I just care that it's lean and won't hog all my
memory if I run it on a small box.
 

-- 
Jonathan Wiltshire

PGP/GPG: 0xDB800B52 / 4216 F01F DCA9 21AC F3D3  A903 CA6B EA3E DB80 0B52
Template: apt-cacher-ng/modifytargets
Type: boolean
Default: true
_Description: Transparently divert requests?
 If enabled, apt-cacher-ng will request packages from a mirror of your
 choosing, instead of the one requested by the client. If disabled, the
 client's request will be respected.
 .
 You can choose how this feature should behave in the next step.

Template: apt-cacher-ng/gentargetmode
Type: boolean
Default: true
_Description: Update the mirror list automatically?
 A seperate mirror list is kept by apt-cacher-ng, which starts as a copy of
 /etc/apt/sources.list. If you enable this option, the mirror list will
 be copied again each time apt-cacher-ng is updated. This ensures that
 if you change APT's list in the future, apt-cacher-ng reflects this.
--- ../apt-cacher-ng.old/debian/apt-cacher-ng.templates	2009-05-27 20:37:13.000000000 +0100
+++ debian/apt-cacher-ng.templates	2009-05-28 22:48:07.000000000 +0100
@@ -1,20 +1,18 @@
 Template: apt-cacher-ng/modifytargets
 Type: boolean
 Default: true
-_Description: Configure apt-cacher-ng to transparently reroute requests to different mirrors?
- Apt-cacher-ng can silently and transparently reroute user requests to
- different mirror(s). To simplify required configuration this setup can create
- or modify lists of target hosts.
+_Description: Transparently divert requests?
+ If enabled, apt-cacher-ng will request packages from a mirror of your
+ choosing, instead of the one requested by the client. If disabled, the
+ client's request will be respected.
+ .
+ You can choose how this feature should behave in the next step.
 
 Template: apt-cacher-ng/gentargetmode
-Type: select
-_Choices: Create once, Create now and update later, Disable target rerouting
-_Default: Create once
-_Description: Configuration mode of download sources:
- The lists of target mirrors (download sources) for popular distributions can
- be created based on information in the current sources.list file. Optionally,
- the lists can be updated to match sources.list on every later update of the
- apt-cacher-ng package.
- .
- Alternatively, the target mirror rerouting can be disabled now by removing the
- current targets from existing lists.
+Type: boolean
+Default: true
+_Description: Update the mirror list automatically?
+ A seperate mirror list is kept by apt-cacher-ng, which starts as a copy of
+ /etc/apt/sources.list. If you enable this option, the mirror list will
+ be copied again each time apt-cacher-ng is updated. This ensures that
+ if you change APT's list in the future, apt-cacher-ng reflects this.
--- ../apt-cacher-ng.old/debian/control	2009-05-27 20:37:13.000000000 +0100
+++ debian/control	2009-05-28 22:31:21.000000000 +0100
@@ -9,20 +9,20 @@
 Architecture: any
 Depends: ${shlibs:Depends}, ${misc:Depends}, adduser
 Recommends: perl (>> 5.8), ed
-Description: Caching proxy for distribution of software packages
- Apt-Cacher NG is yet another implementation of a HTTP proxy for
- software packages, primarily targeted at Debian/Ubuntu packages but
- may also be used with others types.
+Description: caching proxy for distribution of software packages
+ Apt-Cacher NG is yet another implementation of an HTTP proxy for
+ software packages. It is primarily designed for .deb packages but
+ may also be used with other package types.
  .
- It follows similar principles as others (Apt-Cacher, Apt-Proxy, 
- Approx) and serves the same purpose: a central machine presents the
+ It follows principles similar to many other solutions
+ and serves the same purpose: a central machine presents the
  proxy for a local network and clients configure their APT setup
- to download through it. Apt-Cacher keeps a copy of all useful data
- that has been passed through it and when a similar request appears,
- the old copy of the data is delivered without redownloading it from
- the Debian mirrors.
+ 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 fetching it from
+ the repository all over again.
  .
- Apt-Cacher NG is more than a simple rewrite of Apt-Cacher. It was redesigned
- from scratch and is written in C++ with main focus on maximizing throughput
+ Apt-Cacher NG has been designed
+ from scratch with a focus on maximizing throughput
  with low requirements on system resources. 
 
Source: apt-cacher-ng
Section: net
Priority: optional
Maintainer: Eduard Bloch <blade@debian.org>
Build-Depends: debhelper (>= 5), libbz2-dev, zlib1g-dev, libfuse-dev, pkg-config
Standards-Version: 3.8.1

Package: apt-cacher-ng
Architecture: any
Depends: ${shlibs:Depends}, ${misc:Depends}, adduser
Recommends: perl (>> 5.8), ed
Description: caching proxy for distribution of software packages
 Apt-Cacher NG is yet another implementation of an HTTP proxy for
 software packages. It is primarily designed for .deb packages but
 may also be used with other package types.
 .
 It follows principles similar to many other solutions
 and serves the same purpose: a central machine presents 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 fetching it from
 the repository all over again.
 .
 Apt-Cacher NG has been designed
 from scratch with a focus on maximizing throughput
 with low requirements on system resources. 

Attachment: signature.asc
Description: Digital signature


Reply to: