From 5f4331c4d265aa83229e3e58edd49e54731fb646 Mon Sep 17 00:00:00 2001 From: David Kalnischkies Date: Thu, 29 Oct 2009 00:14:21 +0100 Subject: correct various errors, typos and oddities in the manpages Patch by Chris Leick which closes his on bug. Thanks! * doc/ various manpages: - correct various errors, typos and oddities (Closes: #552535) * doc/apt-secure.8.xml: - replace literal with emphasis tags in Archive configuration --- debian/changelog | 6 ++++++ doc/apt-cache.8.xml | 2 +- doc/apt-extracttemplates.1.xml | 2 +- doc/apt-ftparchive.1.xml | 2 +- doc/apt-get.8.xml | 4 ++-- doc/apt-secure.8.xml | 12 ++++++------ doc/apt.conf.5.xml | 18 +++++++++--------- doc/sources.list.5.xml | 14 +++++++------- 8 files changed, 33 insertions(+), 27 deletions(-) diff --git a/debian/changelog b/debian/changelog index 55e191222..88ac07ba2 100644 --- a/debian/changelog +++ b/debian/changelog @@ -35,6 +35,12 @@ apt (0.7.25) UNRELEASED; urgency=low - remove (outdated) config.{sub,guess} and use the ones provided by the new added build-dependency autotools-dev instead + [ Chris Leick ] + * doc/ various manpages: + - correct various errors, typos and oddities (Closes: #552535) + * doc/apt-secure.8.xml: + - replace literal with emphasis tags in Archive configuration + [ Eugene V. Lyubimkin ] * apt-pkg/contib/strutl.h - Avoid extra inner copy in APT_MKSTRCMP and APT_MKSTRCMP2. diff --git a/doc/apt-cache.8.xml b/doc/apt-cache.8.xml index c61d00e47..538de3c27 100644 --- a/doc/apt-cache.8.xml +++ b/doc/apt-cache.8.xml @@ -151,7 +151,7 @@ Reverse Provides: Missing is the number of package names that were referenced in a dependency but were not provided by any package. Missing packages may - be in evidence if a full distribution is not accessed, or if a package + be an evidence if a full distribution is not accessed, or if a package (real or virtual) has been dropped from the distribution. Usually they are referenced from Conflicts or Breaks statements. diff --git a/doc/apt-extracttemplates.1.xml b/doc/apt-extracttemplates.1.xml index 77b837022..9f8a4056d 100644 --- a/doc/apt-extracttemplates.1.xml +++ b/doc/apt-extracttemplates.1.xml @@ -60,7 +60,7 @@ Temporary directory in which to write extracted debconf template files - and config scripts + and config scripts. Configuration Item: APT::ExtractTemplates::TempDir diff --git a/doc/apt-ftparchive.1.xml b/doc/apt-ftparchive.1.xml index 334cc85da..d4d77c68e 100644 --- a/doc/apt-ftparchive.1.xml +++ b/doc/apt-ftparchive.1.xml @@ -158,7 +158,7 @@ The Dir section defines the standard directories needed to locate the files required during the generation process. These - directories are prepended to certain relative paths defined in later + directories are prepended certain relative paths defined in later sections to produce a complete an absolute path. ArchiveDir diff --git a/doc/apt-get.8.xml b/doc/apt-get.8.xml index 4735dcd34..d3c3772bd 100644 --- a/doc/apt-get.8.xml +++ b/doc/apt-get.8.xml @@ -263,7 +263,7 @@ you will properly get another (newer, older or none) source version than the one you have installed or could install. - If the options is specified + If the option is specified then the package will be compiled to a binary .deb using dpkg-buildpackage, if is specified then the source package will not be unpacked. @@ -391,7 +391,7 @@ Simulate prints out a series of lines each one representing a dpkg operation, Configure (Conf), - Remove (Remv), Unpack (Inst). Square brackets indicate broken packages with + Remove (Remv), Unpack (Inst). Square brackets indicate broken packages and empty set of square brackets meaning breaks that are of no consequence (rare). diff --git a/doc/apt-secure.8.xml b/doc/apt-secure.8.xml index 20f473f77..908fc342f 100644 --- a/doc/apt-secure.8.xml +++ b/doc/apt-secure.8.xml @@ -68,7 +68,7 @@ different steps. apt-secure is the last step in this chain, trusting an archive does not mean that the packages that you trust it do not contain malicious code but means that you - trust the archive maintainer. Its the archive maintainer + trust the archive maintainer. It's the archive maintainer responsibility to ensure that the archive integrity is correct. @@ -94,7 +94,7 @@ is computed and put in the Packages file. The MD5 sum of all of the packages files are then computed and put into the Release file. The Release file is then signed by the archive key (which is created - once a year and distributed through the FTP server. This key is + once a year) and distributed through the FTP server. This key is also on the Debian keyring. @@ -157,15 +157,15 @@ - Create a toplevel Release - file. if it does not exist already. You can do this + Create a toplevel Release + file, if it does not exist already. You can do this by running apt-ftparchive release (provided in apt-utils). - Sign it. You can do this by running + Sign it. You can do this by running gpg -abs -o Release.gpg Release. - Publish the key fingerprint, + Publish the key fingerprint, that way your users will know what key they need to import in order to authenticate the files in the archive. diff --git a/doc/apt.conf.5.xml b/doc/apt.conf.5.xml index 6ee719987..e2db9defb 100644 --- a/doc/apt.conf.5.xml +++ b/doc/apt.conf.5.xml @@ -48,9 +48,9 @@ loading even more config files. The configuration file is organized in a tree with options organized into - functional groups. option specification is given with a double colon + functional groups. Option specification is given with a double colon notation, for instance APT::Get::Assume-Yes is an option within - the APT tool group, for the Get tool. options do not inherit from their + the APT tool group, for the Get tool. Options do not inherit from their parent groups. Syntactically the configuration language is modeled after what the ISC tools @@ -58,7 +58,7 @@ // are treated as comments (ignored), as well as all text between /* and */, just like C/C++ comments. Each line is of the form - APT::Get::Assume-Yes "true"; The trailing + APT::Get::Assume-Yes "true";. The trailing semicolon and the quotes are required. The value must be on one line, and there is no kind of string concatenation. It must not include inside quotes. The behavior of the backslash "\" and escaped characters inside a value is @@ -265,7 +265,7 @@ DPkg::Pre-Install-Pkgs {"/usr/sbin/dpkg-preconfigure --apt";}; this applies to all things including connection timeout and data timeout. One setting is provided to control the pipeline depth in cases where the - remote server is not RFC conforming or buggy (such as Squid 2.0.2) + remote server is not RFC conforming or buggy (such as Squid 2.0.2). Acquire::http::Pipeline-Depth can be a value from 0 to 5 indicating how many outstanding requests APT should send. A value of zero MUST be specified if the remote host does not properly linger @@ -536,9 +536,9 @@ DPkg::TriggersPending "true"; DPkg::NoTriggers - Add the no triggers flag to all dpkg calls (expect the ConfigurePending call). + Add the no triggers flag to all dpkg calls (except the ConfigurePending call). See &dpkg; if you are interested in what this actually means. In short: dpkg will not run the - triggers then this flag is present unless it is explicit called to do so in an extra call. + triggers when this flag is present unless it is explicitly called to do so in an extra call. Note that this option exists (undocumented) also in older apt versions with a slightly different meaning: Previously these option only append --no-triggers to the configure calls to dpkg - now apt will add these flag also to the unpack and remove calls. @@ -549,8 +549,8 @@ DPkg::TriggersPending "true"; The "smart" way is it to configure only packages which need to be configured before another package can be unpacked (Pre-Depends) and let the rest configure by dpkg with a call generated by the next option. "no" on the other hand will not configure anything and totally - relay on dpkg for configuration (which will at the moment fail if a Pre-Depends is encountered). - Setting this option to another than the all value will implicit activate also the next option per + rely on dpkg for configuration (which will at the moment fail if a Pre-Depends is encountered). + Setting this option to another than the all value will implicitly activate also the next option per default as otherwise the system could end in an unconfigured status which could be unbootable! @@ -558,7 +558,7 @@ DPkg::TriggersPending "true"; If this option is set apt will call dpkg --configure --pending to let dpkg handle all required configurations and triggers. This option is activated automatic per default if the previous option is not set to all, but deactivating could be useful - if you want to run APT multiple times in a row - e.g. in an installer. In this sceneries you could + if you want to run APT multiple times in a row - e.g. in an installer. In these sceneries you could deactivate this option in all but the last run. DPkg::TriggersPending diff --git a/doc/sources.list.5.xml b/doc/sources.list.5.xml index 379112c83..0f788aca1 100644 --- a/doc/sources.list.5.xml +++ b/doc/sources.list.5.xml @@ -34,13 +34,13 @@ The package resource list is used to locate archives of the package distribution system in use on the system. At this time, this manual page documents only the packaging system used by the Debian GNU/Linux system. - This control file is located in /etc/apt/sources.list + This control file is /etc/apt/sources.list. The source list is designed to support any number of active sources and a variety of source media. The file lists one source per line, with the most preferred source listed first. The format of each line is: type uri args The first item, type - determines the format for args uri is + determines the format for args. uri is a Universal Resource Identifier (URI), which is a superset of the more specific and well-known Universal Resource Locator, or URL. The rest of the line can be marked as a comment @@ -64,14 +64,14 @@ stable unstable or testing while component is one of main contrib non-free or - non-us The + non-us. The deb-src type describes a debian distribution's source code in the same form as the deb type. A deb-src line is required to fetch source indexes. The format for a sources.list entry using the - deb and deb-src types are: + deb and deb-src types is: deb uri distribution [component1] [component2] [...] @@ -79,7 +79,7 @@ Debian distribution, from which APT will find the information it needs. distribution can specify an exact path, in which case the components must be omitted and distribution must end with - a slash (/). This is useful for when only a particular sub-section of the + a slash (/). This is useful for when the case only a particular sub-section of the archive denoted by the URI is of interest. If distribution does not specify an exact path, at least one component must be present. @@ -143,7 +143,7 @@ deb http://http.us.debian.org/debian dists/stable-updates/ http://server:port/, the proxy server specified in http_proxy will be used. Users of authenticated HTTP/1.1 proxies may use a string of the format - http://user:pass@server:port/ + http://user:pass@server:port/. Note that this is an insecure method of authentication. @@ -211,7 +211,7 @@ deb http://http.us.debian.org/debian dists/stable-updates/ Uses FTP to access the archive at ftp.debian.org, under the debian directory, and uses only the unstable/contrib area. If this line appears as - well as the one in the previous example in sources.list. + well as the one in the previous example in sources.list a single FTP session will be used for both resource lines. deb ftp://ftp.debian.org/debian unstable contrib -- cgit v1.2.3-70-g09d2