[Apt-listbugs-commits] [SCM] apt-listbugs development tree branch, master, updated. apt-listbugs/0.1.6-12-g05a62a7

Francesco Poli (wintermute) invernomuto at paranoici.org
Fri May 18 21:32:06 UTC 2012


The following commit has been merged in the master branch:
commit f00d85424c649ee7c4b4c9c33f41acd3bcdebb46
Author: Francesco Poli (wintermute) <invernomuto at paranoici.org>
Date:   Thu May 17 00:08:03 2012 +0200

    improve style of README.Debian

diff --git a/debian/README.Debian b/debian/README.Debian
index 7f962d3..318a498 100644
--- a/debian/README.Debian
+++ b/debian/README.Debian
@@ -6,16 +6,16 @@ The Debian Package apt-listbugs
 Introduction
 ============
 
-'apt-listbugs' is a tool which retrieves bug reports from the Debian
+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', or other similar package managers,
+be invoked before each upgrade by apt, or other similar package managers,
 in order to check whether the upgrade/installation is safe.
 
 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 and convenient tool to let your system easily track the
+apt is a great and convenient tool 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,
@@ -24,11 +24,11 @@ the package will soon get installed on many Debian systems.
 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
+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.
 
-You can easily install it by using 'apt'. Usually, no customization
+You can easily install apt-listbugs by using apt. 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.
 
@@ -36,12 +36,12 @@ to reduce the number of accesses to the BTS.
 Notes
 =====
 
-This version of 'apt-listbugs' uses the Debian BTS SOAP interface for
+This version of apt-listbugs uses the Debian BTS SOAP interface for
 bug retrieval.
 
-'apt-listbugs' has a simple built-in interactive viewer. It uses
+apt-listbugs has a simple built-in interactive viewer. It uses the
 querybts program as a back-end. To enable this feature, you need to
-install the '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.
@@ -50,23 +50,23 @@ 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 from the 'sensible-utils' package is also available.
+sensible-browser from the sensible-utils package is also available.
 
 
 Need for a controlling terminal (/dev/tty)
 ==========================================
 
-'apt-listbugs' requires a controlling terminal for user interaction.
+apt-listbugs requires a controlling terminal for user interaction.
 It will default to non-interactive failure mode, if its standard output
 is not a tty.
 
-When the command is "apt", 'apt-listbugs' will also default to
+When the command is "apt", apt-listbugs will also default to
 non-interactive failure mode, if it cannot open /dev/tty .
-This may happen when 'apt-listbugs' is (directly or indirectly) invoked
+This may happen when apt-listbugs is (directly or indirectly) invoked
 inside an  su -c "command" : commands invoked this way will have no
 controlling terminal, because of a security fix applied to package
 login from version 1:4.1.5-1 on (see bug #628843). Hence, if you want
-to use 'apt-listbugs' interactively, please do *not* invoke it (or the
+to use apt-listbugs interactively, please do *not* invoke it (or the
 package manager that will invoke it) through the  su -c "command"
 mechanism. 
 
@@ -74,7 +74,7 @@ Also, please note that some package managers (such as aptitude, wajig,
 and possibly other ones), when run as a regular user, tend to gain root
 privileges through the  su -c "command"  mechanism, for the actions that
 need these privileges.
-Hence, if you want to use 'apt-listbugs' interactively, please become root
+Hence, if you want to use apt-listbugs interactively, please become root
 *before* invoking the package manager, as in:
 
     $ su -
@@ -110,9 +110,9 @@ You will have a configuration like:
 
     Acquire::http { Proxy "http://CacheServerIp:3142"; };
 
-for apt-cacher, add a specific proxy configuration line for
+for apt-cacher; add a specific proxy configuration line for
 bugs.debian.org so that apt-listbugs can use a different
-configuration.
+configuration:
 
     Acquire::http::Proxy::bugs.debian.org "DIRECT";
 
@@ -120,21 +120,21 @@ configuration.
 Use of apt-listbugs in unattended installations/upgrades
 ========================================================
 
-As previously mentioned, 'apt-listbugs' requires a console for user
+As previously mentioned, apt-listbugs requires a console for user
 interaction. This could make coexistence with unattended package
-installations/upgrades (e.g.: see the 'cron-apt' package) a little harder.
+installations/upgrades (e.g.: see the cron-apt package) a little harder.
 
-With its default configuration, 'apt-listbugs' will stop any
+With its default configuration, apt-listbugs will stop any
 automatic installation or upgrade, whenever the packages to be
 installed or upgraded are affected by RC bugs.
 
 If this is the desired behavior, no special action is needed: you may
 safely skip the rest of this section.
 
-On the other hand, if you want 'apt-listbugs' to merely show bugs,
+On the other hand, if you want apt-listbugs to merely show bugs,
 without stopping the installation/upgrade process, you can obtain this
 behavior, by editing /etc/apt/apt.conf.d/10apt-listbugs to add the yes
-option '-y': the following line
+option "-y": the following line
 
     DPkg::Pre-Install-Pkgs {"/usr/sbin/apt-listbugs apt || exit 10";};
 
@@ -146,10 +146,10 @@ Please note that this configuration could even be made conditional:
 
     DPkg::Pre-Install-Pkgs {"/usr/sbin/apt-listbugs $APT_LISTBUGS_OPTS apt || exit 10";};
 
-This way, 'apt-listbugs' will avoid stopping the installation/upgrade
+This way, apt-listbugs will avoid stopping the installation/upgrade
 process *only* if an APT_LISTBUGS_OPTS environment variable is set to "-y".
 Otherwise, if APT_LISTBUGS_OPTS is unset (or set to a zero-length
-string), 'apt-listbugs' will behave as usual.
+string), apt-listbugs will behave as usual.
 
 However, such a conditional configuration is probably a bit risky,
 since *anything* could be included (even by mistake) in the
@@ -205,8 +205,8 @@ There's a way to work around the lack of version tracking info
 for the "affects" field: whenever you find yourself in scenario 1,
 file a dummy bug report against package A, marking it as found in
 version a1 and as blocked by the actual bug report (the one assigned
-to package B). A descriptive bug report title, citing the interaction
-with package B, is recommended, in order to let users quickly see
+to package B). Please choose a descriptive bug report title, citing
+the interaction with package B, in order to let users quickly see
 whether they should worry about the issue.
 Anyway, please take into account that this strategy is sub-optimal
 and may annoy some package maintainers!
@@ -232,15 +232,15 @@ Debugging and filing bug reports against apt-listbugs
 =====================================================
 
 When there is an error, to obtain useful debugging information,
-please run apt-listbugs with the debug option '-d'.
+please run apt-listbugs with the debug option "-d".
 
-If the error was encountered when using 'apt-listbugs list' or
-'apt-listbugs rss', just re-run the command-line with the '-d' option
+If the error was encountered when using "apt-listbugs list" or
+"apt-listbugs rss", just re-run the command-line with the "-d" option
 added, and attach the output along with your bug report.
 
-If the error was encountered when using 'apt-listbugs apt' (within
+If the error was encountered when using "apt-listbugs apt" (within
 an apt session), you may enable debug output by editing
-/etc/apt/apt.conf.d/10apt-listbugs to add the debug option '-d':
+/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";};

-- 
apt-listbugs development tree



More information about the Apt-listbugs-commits mailing list