From 30e6fad9ad892a21d271fa93319f7a3ee23da134 Mon Sep 17 00:00:00 2001 From: Martin Michlmayr Date: Thu, 4 Apr 2019 20:20:44 +0700 Subject: Perform minor copy-editing on the docs --- README.md | 16 ++++++++-------- doc/acquire-additional-files.md | 2 +- doc/apt-cache.8.xml | 4 ++-- doc/apt-ftparchive.1.xml | 4 ++-- doc/apt-key.8.xml | 2 +- doc/apt-transport-http.1.xml | 2 +- doc/apt.8.xml | 2 +- doc/apt.conf.5.xml | 4 ++-- doc/json-hooks-protocol.md | 2 +- doc/sources.list.5.xml | 6 +++--- 10 files changed, 22 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 8a8b3b6ed..6fdb393f8 100644 --- a/README.md +++ b/README.md @@ -29,8 +29,8 @@ alongside various additional binaries like the acquire-methods used by them. Bindings for Python ([python-apt](https://tracker.debian.org/pkg/python-apt)) and Perl ([libapt-pkg-perl](https://tracker.debian.org/pkg/libapt-pkg-perl)) are available as separated projects. -Discussion happens mostly on [the mailinglist](mailto:deity@lists.debian.org) ([archive](https://lists.debian.org/deity/)) and on [IRC](irc://irc.oftc.net/debian-apt). -Our bugtracker as well as a general overview can be found at the [Debian Tracker page](https://tracker.debian.org/pkg/apt). +Discussion happens mostly on [the mailing list](mailto:deity@lists.debian.org) ([archive](https://lists.debian.org/deity/)) and on [IRC](irc://irc.oftc.net/debian-apt). +Our bug tracker as well as a general overview can be found at the [Debian Tracker page](https://tracker.debian.org/pkg/apt). Contributing @@ -84,12 +84,12 @@ as well as the manpages and other documentation shipped with APT. ### Bug triage Software tools like APT which are used by thousands of users every -day have a steady flow of incoming bugreports. Not all of them are really +day have a steady flow of incoming bug reports. Not all of them are really bugs in APT: It can be packaging bugs like failing maintainer scripts a user reports against apt, because apt was the command he executed leading to this failure or various wishlist items for new features. Given enough time also the occasional duplicate enters the system. -Our bugtracker is therefore full with open bugreports which are waiting for you! ;) +Our bug tracker is therefore full with open bug reports which are waiting for you! ;) Testing ------- @@ -106,7 +106,7 @@ configuration file. ### Integration tests -There is an extensive integration testsuite available which can be run via: +There is an extensive integration test suite available which can be run via: $ ./test/integration/run-tests @@ -151,7 +151,7 @@ triager easily, it is beneficial to ask the reporter for the `/var/lib/dpkg/status` file, which includes the packages installed on the system and in which version. Such a file can then be used via the option `dir::state::status`. Beware of different architecture settings! -Bugreports usually include this information in the template. Assuming you +Bug reports usually include this information in the template. Assuming you already have the `Packages` files for the architecture (see `sources.list` manpage for the `arch=` option) you can change to a different architecture with a config file like: @@ -207,8 +207,8 @@ Additional documentation Many more things could and should be said about APT and its usage but are more targeted at developers of related programs or only of special interest. -* [Protocol specification of APTs communication with external dependency solvers (EDSP)](./doc/external-dependency-solver-protocol.md) -* [Protocol specification of APTs communication with external installation planners (EIPP)](./doc/external-installation-planner-protocol.md) +* [Protocol specification of APT's communication with external dependency solvers (EDSP)](./doc/external-dependency-solver-protocol.md) +* [Protocol specification of APT's communication with external installation planners (EIPP)](./doc/external-installation-planner-protocol.md) * [Howto use and configure APT to acquire additional files in 'update' operations](./doc/acquire-additional-files.md) * [Download and package installation progress reporting details](./doc/progress-reporting.md) * [Remarks on DNS SRV record support in APT](./doc/srv-records-support.md) diff --git a/doc/acquire-additional-files.md b/doc/acquire-additional-files.md index 30c83ef25..5b0335bc2 100644 --- a/doc/acquire-additional-files.md +++ b/doc/acquire-additional-files.md @@ -96,7 +96,7 @@ Additional optional properties: deal with compressed files transparently you have to explicitly set this option to `false` to avoid problems with users setting the option globally. On the other hand, if you set it to `true` or don't set it you - have to ensure your front-end can deal with all compressed fileformats + have to ensure your front-end can deal with all compressed file formats supported by apt (libapt users can e.g. use `FileFd`, others can use the `cat-file` command of `/usr/lib/apt/apt-helper`). * `Fallback-Of`: Is by default not set. If it is set and specifies another diff --git a/doc/apt-cache.8.xml b/doc/apt-cache.8.xml index b8c6aa989..fdb25ee03 100644 --- a/doc/apt-cache.8.xml +++ b/doc/apt-cache.8.xml @@ -54,7 +54,7 @@ showpkg displays information about the packages listed on the - command line. Remaining arguments are package names. The available + command line. Remaining arguments are package names. The available versions and reverse dependencies of each package listed are listed, as well as forward dependencies for each version. Forward (normal) dependencies are those packages upon which the package in question @@ -208,7 +208,7 @@ Reverse Provides: - dotty takes a list of packages on the command line and + dotty takes a list of packages on the command line and generates output suitable for use by dotty from the GraphViz package. The result will be a set of nodes and edges representing the diff --git a/doc/apt-ftparchive.1.xml b/doc/apt-ftparchive.1.xml index 246cc03d3..32b01aa82 100644 --- a/doc/apt-ftparchive.1.xml +++ b/doc/apt-ftparchive.1.xml @@ -32,7 +32,7 @@ &synopsis-command-apt-ftparchive; Description - apt-ftparchive is the command line tool that generates the index + apt-ftparchive is the command line tool that generates the index files that APT uses to access a distribution source. The index files should be generated on the origin site based on the content of that site. @@ -584,7 +584,7 @@ for i in Sections do as the now outdated cached metadata like size and checksums will be used. With this option enabled this will no longer happen as it will be checked if the file was changed. Note that this option is set to "false" by default as it is not recommend - to upload multiply versions/builds of a package with the same versionnumber, so in theory + to upload multiply versions/builds of a package with the same version number, so in theory nobody will have these problems and therefore all these extra checks are useless. diff --git a/doc/apt-key.8.xml b/doc/apt-key.8.xml index a1c677d65..31bd3d862 100644 --- a/doc/apt-key.8.xml +++ b/doc/apt-key.8.xml @@ -40,7 +40,7 @@ Note that if usage of apt-key is desired the additional installation of the GNU Privacy Guard suite (packaged in gnupg) is required. For this reason alone the programmatic - usage (especially in package maintainerscripts!) is strongly discouraged. + usage (especially in package maintainer scripts!) is strongly discouraged. Further more the output format of all commands is undefined and can and does change whenever the underlying commands change. apt-key will try to detect such usage and generates warnings on stderr in these cases. diff --git a/doc/apt-transport-http.1.xml b/doc/apt-transport-http.1.xml index f239da554..92fac0467 100644 --- a/doc/apt-transport-http.1.xml +++ b/doc/apt-transport-http.1.xml @@ -51,7 +51,7 @@ server limitations. The environment variable http_proxy is supported for system wide configuration. Proxies specific to APT can be configured via the option Acquire::http::Proxy. Proxies which should be used only for certain hosts can be specified via -Acquire::http::Proxy::host. Even more finegrained control +Acquire::http::Proxy::host. Even more fine-grained control can be achieved via proxy autodetection, detailed further below. All these options use the URI format scheme://[[user][:pass]@]host[:port]/. Supported URI schemes are socks5h (SOCKS5 with remote DNS resolution), http and https. diff --git a/doc/apt.8.xml b/doc/apt.8.xml index f81ae18d3..e43ad9e9e 100644 --- a/doc/apt.8.xml +++ b/doc/apt.8.xml @@ -140,7 +140,7 @@ (work-in-progress) edit-sources lets you edit - your &sources-list; files in your preferred texteditor while also + your &sources-list; files in your preferred text editor while also providing basic sanity checks. diff --git a/doc/apt.conf.5.xml b/doc/apt.conf.5.xml index 5ce693c2c..fdb1023a7 100644 --- a/doc/apt.conf.5.xml +++ b/doc/apt.conf.5.xml @@ -254,7 +254,7 @@ APT::Compressor::rev { with this option disabled you should try to explicitly install the package APT is unable to configure immediately; but please make sure you also report your problem to your - distribution and to the APT team with the buglink below, so they can + distribution and to the APT team with the bug link below, so they can work on improving or correcting the upgrade process. @@ -431,7 +431,7 @@ APT::Compressor::rev { - The options in these scopes configure APTs acquire transports for the protocols + The options in these scopes configure APT's acquire transports for the protocols HTTP and HTTPS and are documented in the &apt-transport-http; and &apt-transport-https; manpages respectively. diff --git a/doc/json-hooks-protocol.md b/doc/json-hooks-protocol.md index ddf0fa0e3..09633e71d 100644 --- a/doc/json-hooks-protocol.md +++ b/doc/json-hooks-protocol.md @@ -27,7 +27,7 @@ The general life of a hook is as following. It is unspecified whether a hook is sent one or more messages. For example, a hook may be started only once for the lifetime of the apt -process and receive multiple notificatgions, but a hook may also be +process and receive multiple notifications, but a hook may also be started multiple times. Hooks should thus be stateless. ## JSON messages diff --git a/doc/sources.list.5.xml b/doc/sources.list.5.xml index 302154999..7395a74f3 100644 --- a/doc/sources.list.5.xml +++ b/doc/sources.list.5.xml @@ -99,7 +99,7 @@ usually easier to add the field "Enabled: no" to the stanza to disable the entry. Removing the field or setting it to yes re-enables it. - Options have the same syntax as every other field: A fieldname separated by + Options have the same syntax as every other field: A field name separated by a colon (:) and optionally spaces from its value(s). Note especially that multiple values are separated by whitespaces (like spaces, tabs and newlines), not by commas as in the one-line format. @@ -198,7 +198,7 @@ deb-src [ option1=value1 option2=value2 ] uri suite [component1] [component2] [. is accessed and how data is acquired from it. Format, syntax and names of the options vary between the one-line-style and deb822-style formats as described, but they both have the same options available. For simplicity - we list the deb822 fieldname and provide the one-line name in brackets. + we list the deb822 field name and provide the one-line name in brackets. Remember that besides setting multivalue options explicitly, there is also the option to modify them based on the default, but we aren't listing those names explicitly here. Unsupported options are silently ignored by all @@ -398,7 +398,7 @@ deb-src [ option1=value1 option2=value2 ] uri suite [component1] [component2] [. communication with the remote server (or proxy) is not encrypted so a sufficiently capable attacker can observe and record login as well as all other interactions. The attacker can not modify the - communication through as APTs data security model is independent of the + communication through as APT's data security model is independent of the chosen transport method. See &apt-secure; for details. -- cgit v1.2.3