[Apt-listbugs-commits] [SCM] apt-listbugs development tree branch, master, updated. 0.1.0-20-g2b90030

Sun Oct 18 18:13:49 UTC 2009

The following commit has been merged in the master branch:
commit 82c035e2995cce6057ce6139576f7bd0538047f1
Author: Francesco Poli (t1000) <frx at firenze.linux.it>
Date:   Sat Sep 12 18:15:25 2009 +0200

    removed some dust from README.Debian
    
    Some parts of this document required an update to reflect the current
    situation.  Minor cosmetic changes were also applied.

diff --git a/debian/README.Debian b/debian/README.Debian
index e42f157..bc371b5 100644
--- a/debian/README.Debian
+++ b/debian/README.Debian
@@ -1,65 +1,59 @@
+-------------------------------
 The Debian Package apt-listbugs
 -------------------------------
 
+
 Introduction
 ============
 
 'apt-listbugs' is a tool which retrieves bug reports from the Debian
 Bug Tracking System and lists them. Especially, it is intended to
-be invoked before each upgrade by apt in order to check whether
-the upgrade is safe. 
+be invoked before each upgrade by apt or aptitude in order to check whether
+the upgrade is safe.
 
-Most of Debian developers use the unstable version of Debian
-and some users also use it because the version is the latest
+Most Debian developers use the unstable version of Debian,
+and some users also use it, because this version is the latest
 snapshot which includes many features and new packages.
 
-'apt' is a great convenient tool to follow your system to the latest
-version easily. On the other hand, the feature also makes your system
-break easily. If a package is broken and uploaded to the Debian unstable,
-the package will be installed on many Debian system soon.
+'apt' and 'aptitude' are great and convenient tools to let your system
+easily track the latest package versions from unstable.
+On the other hand, this possibility also makes your system
+break easily. If a broken package is uploaded to Debian unstable,
+the package will soon get installed on many Debian systems.
 
-From a debian developer's point of view, many bug reports are reported
-for only one bug. Unfortunately, these bugs are usually reported to several
-packages.
-
-You can install it easily by apt. Usually, customisation is not
-required. However, I do strongly suggest use of proxy server in order
-to reduce the number of accesses to the BTS.
+The same reasoning holds for the testing version of Debian, even
+though to a smaller extent.
 
+'apt-listbugs' may be helpful by warning its users about bugs in packages
+which are about to be installed/upgraded and by giving the opportunity
+to avoid or defer an unsafe installation/upgrade.
 
-Bug information retrieval
-=========================
+You can install it easily by using apt or aptitude. Usually, no customization
+is required. However, the use of a proxy server is recommended, in order
+to reduce the number of accesses to the BTS.
 
-This version of 'apt-listbugs' uses bugs.debian.org for bug
-retrieval. It retrieves index from bugs.debian.org/indices/ (currently
-redirected to merkel.debian.org/~dancer/apt-listbugs/), and each bug
-via SOAP interface on bugs.debian.org (currently a redirect to
-bugs.donarmstrong.com).
 
 Notes
 =====
 
-'apt-listbugs' requires a console for user interaction. It will
-default to noninteractive failure more if tty is not available.
+This version of 'apt-listbugs' uses the Debian BTS SOAP interface for
+bug retrieval.
 
-By default, 'apt-listbugs' retrieves bug reports from the local
-cache. Because it's not possible to know if the cache contents are
-up-to-date the reports may be old. The cache will be automatically
-removed in 1 hour (by default). If you want to change the timer, put
-the -t option to apt-listbugs.  Use -f option to force refresh.
+'apt-listbugs' requires a console for user interaction. It will
+default to non-interactive failure mode, if tty is not available.
 
-'apt-listbugs' has a simple interactive viewer built-in. It uses
+'apt-listbugs' has a simple built-in interactive viewer. It uses
 querybts program as a back-end. To enable this feature, you need to
-install 'reportbug' package. In addition, you can select broken
+install the 'reportbug' package. In addition, you can select broken
 packages for pinning, to avoid automatically upgrading them. However,
 pinning is not effective immediately, and requires restarting your apt
-session.
+or aptitude session.
 
 The pinning will be removed by a cron.daily job, when the bugs no longer
 affect the package candidate version.
 
-If you install www-browser, you can view bug lists in html.
-sensible-browser in debianutils (>= 2.0) also available.
+If you install www-browser, you can view bug lists in HTML.
+sensible-browser from the 'sensible-utils' package is also available.
 
 
 Current Design Limitation
@@ -72,20 +66,6 @@ version tracking not functioning for such packages. A popular example
 of such package is gcc.
 
 
-apt-setup bug
-=============
-
-During Etch development, there was a time where apt-setup had a bug,
-and put 'false' as Acquire::http::proxy configuration.  (Bug: #378868)
-Remove the line saying 
-	Acquire::http::proxy 'false' 
-from apt.conf
-
-Reading package fields... Done
-Reading package status... Done
-Retrieving bug reports... 0% W: unsupported proxy `false'
-
-
 apt-cacher / apt-cacher-ng and proxy configuration
 ==================================================
 
@@ -104,13 +84,14 @@ configuration.
 
     Acquire::http::Proxy::bugs.debian.org "DIRECT";
 
+
 Filing Bugs on apt-listbugs
 ===========================
 
 SOAP_USE_PROXY
 --------------
 
-If you intend to file bug on why SOAP_USE_PROXY is required, don't.
+If you intend to file bug on why SOAP_USE_PROXY is required, please don't.
 There's already a bug filed as 399706.
 
 This bug is going to be fixed in future ruby1.8 upstream version of
@@ -121,35 +102,35 @@ Debugging apt-listbugs
 
 When there is an error, to obtain reproducible debugging information,
 please run the following command-line to invoke apt-listbugs with the
-debugging output, and attach the output along with your bugreport.
+debugging output, and attach the output along with your bug report.
 
 (echo 'VERSION 2'; echo '' ;
-	ls -1 /var/cache/apt/archives/PACKAGE_*.deb | 
-	sed 's/^/x x x x /') | 
-	/usr/sbin/apt-listbugs apt -d
- (substitute PACKAGE with the package name)
-
+    ls -1 /var/cache/apt/archives/PACKAGE_*.deb |
+    sed 's/^/x x x x /') |
+    /usr/sbin/apt-listbugs apt -d
 
+where PACKAGE should be substituted with the package name.
 
 Of course, if you are feeling more like contributing to apt-listbugs,
-enable debug output by default by editing
-/etc/apt/apt.conf.d/10apt-listbugs to add the debug option '-d'.
+you could enable debug output by default by editing
+/etc/apt/apt.conf.d/10apt-listbugs to add the debug option '-d':
+the following line
 
-	DPkg::Pre-Install-Pkgs {"/usr/sbin/apt-listbugs apt || exit 10"};
+    DPkg::Pre-Install-Pkgs {"/usr/sbin/apt-listbugs apt || exit 10";};
 
-to read
-
-	DPkg::Pre-Install-Pkgs {"/usr/sbin/apt-listbugs apt -d || exit 10"};
+should become
 
+    DPkg::Pre-Install-Pkgs {"/usr/sbin/apt-listbugs apt -d || exit 10";};
 
 
 Hacking apt-listbugs
 ====================
 
-There is so much more information about debbugs SOAP debbugs interface
-available from debbbugs source.
+There is so much more information about the BTS SOAP interface
+available from debbugs source:
+http://bugs.debian.org/debbugs-source/mainline/Debbugs/Bugs.pm
 
-	http://bugs.debian.org/debbugs-source/mainline/Debbugs/Bugs.pm
 
  -- Junichi Uekawa <dancer at debian.org>, Wed,  1 Oct 2008 20:50:27 -0700
- -- Francesco Poli (t1000) <frx at firenze.linux.it>  Mon, 27 Apr 2009 23:07:41 +0200
+ -- Francesco Poli (t1000) <frx at firenze.linux.it>  Sat, 12 Sep 2009 17:47:37 +0200
+
diff --git a/debian/changelog b/debian/changelog
index 683efd5..cd2dca7 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -3,13 +3,14 @@ apt-listbugs (0.1.1) UNRELEASED; urgency=low
   [ Francesco Poli (t1000) ]
   * enhance BTS SOAP reply parsing: drop '\r' characters from bug subjects
   * bump Standards-Version to 3.8.3: no changes needed
+  * updated README.Debian, by dropping or modifying obsolete parts
 
   [ Ryan Niebur ]
   * updated italian translation, thanks Luca (Closes: #540344)
   * LC_ALL=C when running apt-cache, we parse the English output (Closes:
     #547128)
 
- -- Ryan Niebur <ryanryan52 at gmail.com>  Thu, 17 Sep 2009 07:12:54 -0700
+ -- Francesco Poli (t1000) <frx at firenze.linux.it>  Sat, 12 Sep 2009 18:08:39 +0200
 
 apt-listbugs (0.1.0) unstable; urgency=low
 

-- 
apt-listbugs development tree

