Re: [RFR] templates://squid-deb-proxy/{squid-deb-proxy.templates}
Christian PERRIER wrote:
> Your review should be sent as an answer to this mail.
[...]
> Template: squid-deb-proxy/ppa-enable
> Type: boolean
> Default: false
> -_Description: Allow PPA (Personal Package Archive) access?
> - Squid-deb-proxy by default will not allow PPA repositories from launchpad.
> - Selecting Y in this option will activate PPA repo access.
> +_Description: Allow PPA access?
> + By default, squid-deb-proxy does not allow to access Personal Packages
> + Archive (PPA) repositories from Launchpad.
Disallowed! "Allow" needs an object; here the simple fix would be to
say "allow access to [...]". But why are we using the word "allow" in
the first place? Installing squid-deb-proxy has no effect on whether
I'm *permitted* to point my sources.list at a PPA; this debconf
question just determines whether squid-deb-proxy will manage a cache
to optimise package downloads from it.
It's "Personal Package Archive (PPA) repositories". But I would avoid
"access [...] from Launchpad" - make it "repositories on Launchpad".
By default, squid-deb-proxy does not provide caching for Personal
Package Archive (PPA) repositories on Launchpad.
> + .
> + Choosing this option will allow this.
Again avoiding my least favourite word:
Choosing this option will activate this support.
(It also helps smooth over the repeated "this".)
> Template: squid-deb-proxy/acl-disable
> Type: boolean
> Default: false
> _Description: Allow unrestricted network access?
Oh, but now this *does* mean "allow access".
> + By default, squid-deb-proxy restricts access to the cache to private
> + networks (10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16).
> + .
> + Choosing this option will allow other IP addresses to access the cache.
>
> Reformulation to make things clearer (?).
I may be looking too hard for ambiguities, but I'm uneasy with
"restricts access [...] to private networks". I think I prefer:
By default, squid-deb-proxy allows access to the cache from private
networks only (10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16).
On to the control file: the package description is all good idiomatic
en_US, but I'm not entirely sure about the content.
> --- squid-deb-proxy.old/debian/control 2013-04-20 08:32:42.653002140 +0200
> +++ squid-deb-proxy/debian/control 2013-04-28 14:37:16.233346451 +0200
> @@ -18,18 +18,15 @@
> squid3
> Recommends: avahi-utils
> Description: Squid proxy configuration optimized for deb packages
> + This package contains a Squid proxy configuration that is optimized
> for downloading deb packages. It defaults to a different cache
> + directory and port than the regular Squid cache.
Do we need to specify "deb packages"? This software is itself
exclusively available in .deb format; nobody's reading this
description to work out whether they need to install squid-deb-proxy
or squid-rpm-proxy, so the synopsis doesn't really need to say.
And second, how is it "optimised for" .debs? This strikes me as
subtly backwards: Squid is only downloading and caching the files the
way it always does, but the result is that it improves apt-get speeds.
My suggestion:
Description: Squid proxy configuration to optimize package downloads
This package contains a Squid proxy configuration to manage a cache of
.deb package downloads, using a dedicated directory and port.
Or we might want that to say something like "a cache of downloads from
the distribution software repositories to a local network".
> Package: squid-deb-proxy-client
> Architecture: all
> Depends: ${misc:Depends}, avahi-utils, apt (>= 0.7.25.3ubuntu1), python
> +Description: automatic proxy discovery for APT based on avahi
> + This package contains a helper for the APT HTTP method to discover
> proxies that publish their service as _apt_proxy._tcp.
> .
> It was written to be installed on clients that should use
>
> uncapitalize the short description...and capitalize "http" as this is
> an acronym.
Ah, but the APT method is (/usr/lib/apt/methods/)http, lowercase for
more or less the same reason as _apt_proxy._tcp! On the other hand,
Avahi (the service as opposed to the package) is probably entitled to
its capital letter.
--
JBR with qualifications in linguistics, experience as a Debian
sysadmin, and probably no clue about this particular package
diff -ru squid-deb-proxy-0.7.pristine/debian/control squid-deb-proxy-0.7/debian/control
--- squid-deb-proxy-0.7.pristine/debian/control 2013-04-09 18:12:46.000000000 +0100
+++ squid-deb-proxy-0.7/debian/control 2013-04-28 14:57:20.021213377 +0100
@@ -17,19 +17,15 @@
${misc:Depends},
squid3
Recommends: avahi-utils
-Description: Squid proxy configuration optimized for deb packages
- This package contains a squid proxy configuration that is optimized
- for downloading deb packages. It defaults to a different cache
- directory and port than the regular squid cache.
- .
- The config default to allowing cached access from a local network
- to *.archive.ubuntu.com.
+Description: Squid proxy configuration to optimize package downloads
+ This package contains a Squid proxy configuration to manage a cache of
+ .deb package downloads, using a dedicated directory and port.
Package: squid-deb-proxy-client
Architecture: all
Depends: ${misc:Depends}, avahi-utils, apt (>= 0.7.25.3ubuntu1), python
-Description: Automatic proxy discovery for apt based on avahi
- This package contains a helper for the apt http method to discover
+Description: automatic proxy discovery for APT based on Avahi
+ This package contains a helper for the APT http method to discover
proxies that publish their service as _apt_proxy._tcp.
.
It was written to be installed on clients that should use
@@ -41,12 +37,12 @@
Section: debian-installer
Architecture: all
Depends: ${shlibs:Depends}, ${misc:Depends}, configured-network,
-Description: Automatic proxy discovery for apt based on avahi (udeb)
- This package contains a helper for the apt http method to discover
+Description: automatic proxy discovery for APT based on Avahi (udeb)
+ This package contains a helper for the APT http method to discover
proxies that publish their service as _apt_proxy._tcp.
.
It was written to be installed on clients that should use
squid-deb-proxy automatically, but it will work with any proxy
that publishes the service as _apt_proxy._tcp.
.
- This package contains the udeb only
+ This package contains the udeb for use with the Debian Installer.
diff -ru squid-deb-proxy-0.7.pristine/debian/squid-deb-proxy.templates squid-deb-proxy-0.7/debian/squid-deb-proxy.templates
--- squid-deb-proxy-0.7.pristine/debian/squid-deb-proxy.templates 2013-04-06 17:35:46.000000000 +0100
+++ squid-deb-proxy-0.7/debian/squid-deb-proxy.templates 2013-04-28 15:20:40.695175090 +0100
@@ -1,16 +1,17 @@
Template: squid-deb-proxy/ppa-enable
Type: boolean
Default: false
-_Description: Allow PPA (Personal Package Archive) access?
- Squid-deb-proxy by default will not allow PPA repositories from launchpad.
- Selecting Y in this option will activate PPA repo access.
+_Description: Allow PPA access?
+ By default, squid-deb-proxy does not provide caching for Personal
+ Package Archive (PPA) repositories on Launchpad.
+ .
+ Choosing this option will activate this support.
Template: squid-deb-proxy/acl-disable
Type: boolean
Default: false
_Description: Allow unrestricted network access?
- Squid-deb-proxy restricts access to the cache to private networks
- only by default.
- Selecting Y in this option will allow unrestricted access of all IPs
- to access the cache. Selecting N will only allow private networks
- (10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to access the cache.
+ By default, squid-deb-proxy allows access to the cache from private
+ networks only (10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16).
+ .
+ Choosing this option will allow other IP addresses to access the cache.
Template: squid-deb-proxy/ppa-enable
Type: boolean
Default: false
_Description: Allow PPA access?
By default, squid-deb-proxy does not provide caching for Personal
Package Archive (PPA) repositories on Launchpad.
.
Choosing this option will activate this support.
Template: squid-deb-proxy/acl-disable
Type: boolean
Default: false
_Description: Allow unrestricted network access?
By default, squid-deb-proxy allows access to the cache from private
networks only (10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16).
.
Choosing this option will allow other IP addresses to access the cache.
Source: squid-deb-proxy
Section: net
Priority: extra
Maintainer: Michael Vogt <mvo@debian.org>
Build-Depends: debhelper (>= 7.0.50),
gettext,
intltool,
pkg-config,
po-debconf
Standards-Version: 3.9.4
Vcs-Bzr: https://code.launchpad.net/~squid-deb-proxy-developers/squid-deb-proxy/trunk
Homepage: https://launchpad.net/squid-deb-proxy
Package: squid-deb-proxy
Architecture: all
Depends: ${python:Depends},
${misc:Depends},
squid3
Recommends: avahi-utils
Description: Squid proxy configuration to optimize package downloads
This package contains a Squid proxy configuration to manage a cache of
.deb package downloads, using a dedicated directory and port.
Package: squid-deb-proxy-client
Architecture: all
Depends: ${misc:Depends}, avahi-utils, apt (>= 0.7.25.3ubuntu1), python
Description: automatic proxy discovery for APT based on Avahi
This package contains a helper for the APT http method to discover
proxies that publish their service as _apt_proxy._tcp.
.
It was written to be installed on clients that should use
squid-deb-proxy automatically, but it will work with any proxy
that publishes the service as _apt_proxy._tcp.
Package: squid-deb-proxy-client-udeb
XC-Package-Type: udeb
Section: debian-installer
Architecture: all
Depends: ${shlibs:Depends}, ${misc:Depends}, configured-network,
Description: automatic proxy discovery for APT based on Avahi (udeb)
This package contains a helper for the APT http method to discover
proxies that publish their service as _apt_proxy._tcp.
.
It was written to be installed on clients that should use
squid-deb-proxy automatically, but it will work with any proxy
that publishes the service as _apt_proxy._tcp.
.
This package contains the udeb for use with the Debian Installer.
Reply to: