[Apt-listbugs-commits] [apt-listbugs] 07/11: improve style consistency in documentation
Francesco Poli
frx-guest at moszumanska.debian.org
Sat Feb 15 15:26:48 UTC 2014
This is an automated email from the git hooks/post-receive script.
frx-guest pushed a commit to branch master
in repository apt-listbugs.
commit 22d3956ca7864111059ea1dc2db7c1be2562b6ab
Author: Francesco Poli (wintermute) <invernomuto at paranoici.org>
Date: Sun Feb 9 19:07:38 2014 +0100
improve style consistency in documentation
The package manager is named "APT", its Debian binary package
is named "apt".
---
apt-listbugs | 20 ++++++++++----------
aptcleanup | 4 ++--
debian/README.Debian | 18 +++++++++---------
debian/control | 9 +++++----
examples/send-hook-info.rb | 2 +-
lib/apt-listbugs/logic.rb | 6 +++---
lib/debian/apt_preferences.rb | 2 +-
7 files changed, 31 insertions(+), 30 deletions(-)
diff --git a/apt-listbugs b/apt-listbugs
index 2bc5176..42ace4c 100755
--- a/apt-listbugs
+++ b/apt-listbugs
@@ -29,7 +29,7 @@
== NAME
-apt-listbugs - Lists critical bugs before each apt upgrade/installation
+apt-listbugs - Lists critical bugs before each APT upgrade/installation
== SYNOPSIS
@@ -39,7 +39,7 @@ apt-listbugs [options] <command> [arguments]
apt-listbugs is a tool which retrieves bug reports from the Debian
Bug Tracking System and lists them. In particular, 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.
== USAGE
@@ -126,7 +126,7 @@ apt-listbugs [-h] [-v] [-s <severities>] [-T <tags>] [-S <states>] [-B <bug#>] [
* -C <apt.conf>, --aptconf <apt.conf>
- Specifies the apt configuration file to use.
+ Specifies the APT configuration file to use.
* -y, --force-yes
@@ -151,7 +151,7 @@ apt-listbugs [-h] [-v] [-s <severities>] [-T <tags>] [-S <states>] [-B <bug#>] [
: apt
Reads package actions from a file descriptor specified in the
- APT_HOOK_INFO_FD environment variable (typically provided by apt
+ APT_HOOK_INFO_FD environment variable (typically provided by APT
or other compatible package manager; Pre-Install-Pkgs hook info
protocol version 3 is expected - see apt.conf(5) for more details).
@@ -185,7 +185,7 @@ apt-listbugs [-h] [-v] [-s <severities>] [-T <tags>] [-S <states>] [-B <bug#>] [
: APT_HOOK_INFO_FD
- File descriptor from which package actions will be read (apt or other
+ File descriptor from which package actions will be read (APT or other
compatible package managers are expected to write information to this
file descriptor and to properly set this environment variable).
@@ -325,7 +325,7 @@ cur_pkgs = {}
native_arch = nil
case config.command
when "apt"
- # parse apt VERSION 3 input.
+ # parse APT VERSION 3 input.
state=1
apt_hook_fd = ENV["APT_HOOK_INFO_FD"]
puts if $DEBUG
@@ -356,11 +356,11 @@ when "apt"
puts "#{pkg}" if $DEBUG
state=2
else
- $stderr.print _("E: apt Pre-Install-Pkgs is not giving me expected 'VERSION 3' string.\n")
+ $stderr.print _("E: APT Pre-Install-Pkgs is not giving me expected 'VERSION 3' string.\n")
exit 1
end
when 2
- # apt configuration lines
+ # APT configuration lines
case pkg
when ""
puts "#{pkg}" if $DEBUG
@@ -386,7 +386,7 @@ when "apt"
when "**REMOVE**"
# none
when nil
- $stderr.print _("E: apt Pre-Install-Pkgs is giving me fewer fields than expected.\n")
+ $stderr.print _("E: APT Pre-Install-Pkgs is giving me fewer fields than expected.\n")
exit 1
else
case direction
@@ -417,7 +417,7 @@ when "apt"
end
end
else
- $stderr.print _("E: apt Pre-Install-Pkgs is giving me an invalid direction of version change.\n")
+ $stderr.print _("E: APT Pre-Install-Pkgs is giving me an invalid direction of version change.\n")
exit 1
end
end
diff --git a/aptcleanup b/aptcleanup
index 6e736b6..acc79f1 100755
--- a/aptcleanup
+++ b/aptcleanup
@@ -36,12 +36,12 @@ require 'tempfile'
APTCACHE = "/usr/bin/apt-cache"
LISTBUGS = "/usr/sbin/apt-listbugs"
-# read apt preferences
+# read APT preferences
p = Debian::AptPreferences.new
pinned_pkg_keys = []
buggy_pkg_keys = []
-# store apt preferences with no apt-listbugs pins in a temporary file
+# store APT preferences with no apt-listbugs pins in a temporary file
unpinned_pref_file = Tempfile.new('apt_preferences_')
p.filter( buggy_pkg_keys, unpinned_pref_file )
unpinned_pref_file.flush
diff --git a/debian/README.Debian b/debian/README.Debian
index 1f3d9ca..340e9e6 100644
--- a/debian/README.Debian
+++ b/debian/README.Debian
@@ -8,14 +8,14 @@ Introduction
apt-listbugs is a tool which retrieves bug reports from the Debian
Bug Tracking System and lists them. In particular, 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, and some users, use the unstable version of
Debian, because this version is the latest snapshot which includes many
new features and 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 capability can also make your system
fragile. If a broken package is uploaded to Debian unstable,
@@ -28,7 +28,7 @@ apt-listbugs can help 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 apt-listbugs 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.
@@ -37,11 +37,11 @@ How to (temporarily) disable apt-listbugs
=========================================
Sometimes you may need to disable the invocation of apt-listbugs, so
-that you can run apt, or another similar package manager, without
+that you can run APT, or another similar package manager, without
also running apt-listbugs. Hopefully, this will happen very infrequently
and you will immediately want to re-enable apt-listbugs... ;-)
-In order to temporarily disable the invocation of apt-listbugs by apt,
+In order to temporarily disable the invocation of apt-listbugs by APT,
there's no need to remove the package: it is enough to edit
/etc/apt/apt.conf.d/10apt-listbugs and turn the following line
@@ -70,7 +70,7 @@ 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
packages for pinning, to avoid automatically upgrading them. However,
-pinning is not effective immediately, and requires restarting your apt
+pinning is not effective immediately, and requires restarting your APT
session.
The pinning will be removed by a cron.daily job, when the bugs no longer
@@ -102,7 +102,7 @@ Use of apt-cacher/apt-cacher-ng and proxy configuration
=======================================================
When installing apt-cacher or apt-cacher-ng with proxy configuration,
-you will have configured apt proxy settings to use apt-cacher.
+you will have configured APT proxy settings to use apt-cacher.
apt-listbugs will also use that configuration, and since apt-cacher
won't handle POST requests directed to the BTS, it will fail.
@@ -245,7 +245,7 @@ If the error was encountered when using "apt-listbugs list" or
added, and attach the output along with your bug report.
If the error was encountered when using "apt-listbugs apt" (within
-an apt session), you may enable debug output by editing
+an APT session), you may enable debug output by editing
/etc/apt/apt.conf.d/10apt-listbugs to add the debug option "-d":
the following line
@@ -255,7 +255,7 @@ should become
DPkg::Pre-Install-Pkgs {"/usr/sbin/apt-listbugs apt -d";};
-Then please restart the apt session, and attach the output along with
+Then please restart the APT session, and attach the output along with
your bug report.
diff --git a/debian/control b/debian/control
index af49dfa..abcd46e 100644
--- a/debian/control
+++ b/debian/control
@@ -14,15 +14,16 @@ Architecture: all
Depends: ${misc:Depends}, ruby | ruby-interpreter, ruby-debian (>= 0.3.3), apt (>= 0.9.11), ruby-gettext (>= 3.0.2), ruby-xmlparser, ruby-httpclient (>= 2.1.5.2-1), ruby-soap4r
Suggests: reportbug, debianutils (>= 2.0) | www-browser | w3m
Breaks: libapt-pkg4.12 (<< 0.9.11)
-Description: tool which lists critical bugs before each apt installation
+Description: tool which lists critical bugs before each APT installation
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/installation by apt in order to check whether the
+ before each upgrade/installation by APT in order to check whether the
upgrade/installation is safe.
.
Many developers and users prefer the unstable version of Debian for its new
- features and packages. apt, the usual upgrade tool, can break your system by
+ features and packages. APT, the usual upgrade tool, can break your system by
installing a buggy package.
.
apt-listbugs lists critical bug reports from the Debian Bug Tracking System.
- Run it before apt to see if an upgrade or installation is known to be unsafe.
+ Run it from within the APT session, in order to see whether an upgrade or
+ installation is known to be unsafe.
diff --git a/examples/send-hook-info.rb b/examples/send-hook-info.rb
index 2f3df9b..6f3dc8b 100755
--- a/examples/send-hook-info.rb
+++ b/examples/send-hook-info.rb
@@ -3,7 +3,7 @@
# send-hook-info.rb: test helper script that reads a hook info dump from
# a specified file and sends it to a specified command
# through a file descriptor (useful to test
-# "apt-listbugs apt" without the need to invoke apt)
+# "apt-listbugs apt" without the need to invoke APT)
#
# Copyright (C) 2013 Google Inc
# Copyright (C) 2013 Francesco Poli <invernomuto at paranoici.org>
diff --git a/lib/apt-listbugs/logic.rb b/lib/apt-listbugs/logic.rb
index aa7f203..a933252 100644
--- a/lib/apt-listbugs/logic.rb
+++ b/lib/apt-listbugs/logic.rb
@@ -495,11 +495,11 @@ class Viewer
if hold_pkg_keys.empty?
@config.frontend.puts "" +
# TRANSLATORS: the dashes (-) in the following strings are vertically aligned, please keep their alignment consistent
- _(" y - continue the apt installation, but do not mark the bugs\n as ignored.\n") +
- _(" a - continue the apt installation and mark all the above bugs\n as ignored.\n")
+ _(" y - continue the APT installation, but do not mark the bugs\n as ignored.\n") +
+ _(" a - continue the APT installation and mark all the above bugs\n as ignored.\n")
end
@config.frontend.puts "" +
- _(" n - stop the apt installation.\n") +
+ _(" n - stop the APT installation.\n") +
_(" <num> - query the specified bug number (requires reportbug).\n") +
_(" #<num> - same as <num>\n") +
_(" r - redisplay bug lists.\n") +
diff --git a/lib/debian/apt_preferences.rb b/lib/debian/apt_preferences.rb
index d246f8e..8210dea 100644
--- a/lib/debian/apt_preferences.rb
+++ b/lib/debian/apt_preferences.rb
@@ -1,5 +1,5 @@
#
-# apt_preferences.rb - ruby interface for apt preferences
+# apt_preferences.rb - ruby interface for APT preferences
# Copyright (C) 2004 Masato Taruishi <taru at debian.org>
# Copyright (C) 2009-2013 Francesco Poli <invernomuto at paranoici.org>
#
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/apt-listbugs/apt-listbugs.git
More information about the Apt-listbugs-commits
mailing list