From 4010ee76cb1a771d57f1339df725e962df23900e Mon Sep 17 00:00:00 2001 From: Stefano Zacchiroli Date: Tue, 17 Jun 2014 17:03:27 +0200 Subject: EDSP doc: clarify that Install/Remove packages are arch-qualified --- doc/external-dependency-solver-protocol.txt | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) (limited to 'doc/external-dependency-solver-protocol.txt') diff --git a/doc/external-dependency-solver-protocol.txt b/doc/external-dependency-solver-protocol.txt index 790f2f1ee..eb7832120 100644 --- a/doc/external-dependency-solver-protocol.txt +++ b/doc/external-dependency-solver-protocol.txt @@ -5,6 +5,14 @@ external dependency solvers. The protocol is called APT EDSP, for "APT External Dependency Solver Protocol". +## Terminology + +In the following we use the term **architecture qualified package name** +(or *arch-qualified package names* for short) to refer to package +identifiers of the form "arch:package" where "arch" is a dpkg +architecture and "package" a dpkg package name. + + ## Components - **APT**: we know this one. @@ -132,9 +140,9 @@ The following **configuration fields** are supported in request stanzas: The following **action fields** are supported in request stanzas: - **Install:** (optional, defaults to the empty string) A space - separated list of package names, with *no version attached*, to - install. This field denotes a list of packages that the user wants to - install, usually via an APT `install` request. + separated list of arch-qualified package names, with *no version + attached*, to install. This field denotes a list of packages that the + user wants to install, usually via an APT `install` request. - **Remove:** (optional, defaults to the empty string) Same syntax of Install. This field denotes a list of packages that the user wants to @@ -201,7 +209,7 @@ field. The following fields are supported in package stanzas: - **APT-Candidate:** (optional, defaults to `no`). Allowed values: `yes`, `no`. When set to `yes`, the corresponding package is the APT candidate for installation among all available packages with the same - name. + name and with the same architecture. - **APT-Automatic:** (optional, defaults to `no`). Allowed values: `yes`, `no`. When set to `yes`, the corresponding package is marked by -- cgit v1.2.3 From 22c3ac52252b6eafe0d31485b18730cfb53a8dc3 Mon Sep 17 00:00:00 2001 From: Stefano Zacchiroli Date: Tue, 17 Jun 2014 17:04:09 +0200 Subject: EDSP doc: (minor) consistently use 2 blank lines before headings Git-Dch: Ignore --- doc/external-dependency-solver-protocol.txt | 2 ++ 1 file changed, 2 insertions(+) (limited to 'doc/external-dependency-solver-protocol.txt') diff --git a/doc/external-dependency-solver-protocol.txt b/doc/external-dependency-solver-protocol.txt index eb7832120..7db1479b2 100644 --- a/doc/external-dependency-solver-protocol.txt +++ b/doc/external-dependency-solver-protocol.txt @@ -70,6 +70,7 @@ configuration documentation for more, and more up to date, information. - **Dir::Bin::Solvers**: absolute path of the directory where to look for external solvers. Defaults to `/usr/lib/apt/solvers`. + ## Protocol When configured to use an external solver, APT will resort to it to @@ -226,6 +227,7 @@ field. The following fields are supported in package stanzas: Release file entry (Origin, Label, Codename, etc.) in the format of APT_PREFERENCES(5). + ### Answer An answer from the external solver to APT is either a *solution* or an -- cgit v1.2.3 From 82ced5c894cd013721f432ae8da66114155e04c7 Mon Sep 17 00:00:00 2001 From: David Kalnischkies Date: Tue, 17 Jun 2014 19:25:03 +0200 Subject: EDSP doc: some typo and wording fixes Git-Dch: Ignore --- doc/external-dependency-solver-protocol.txt | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'doc/external-dependency-solver-protocol.txt') diff --git a/doc/external-dependency-solver-protocol.txt b/doc/external-dependency-solver-protocol.txt index 7db1479b2..14e9528c8 100644 --- a/doc/external-dependency-solver-protocol.txt +++ b/doc/external-dependency-solver-protocol.txt @@ -9,8 +9,8 @@ External Dependency Solver Protocol". In the following we use the term **architecture qualified package name** (or *arch-qualified package names* for short) to refer to package -identifiers of the form "arch:package" where "arch" is a dpkg -architecture and "package" a dpkg package name. +identifiers of the form "package:arch" where "package" is a package name +and "arch" a dpkg architecture. ## Components @@ -210,7 +210,7 @@ field. The following fields are supported in package stanzas: - **APT-Candidate:** (optional, defaults to `no`). Allowed values: `yes`, `no`. When set to `yes`, the corresponding package is the APT candidate for installation among all available packages with the same - name and with the same architecture. + name and architecture. - **APT-Automatic:** (optional, defaults to `no`). Allowed values: `yes`, `no`. When set to `yes`, the corresponding package is marked by @@ -236,11 +236,11 @@ An answer from the external solver to APT is either a *solution* or an The following invariant on **exit codes** must hold true. When the external solver is *able to find a solution*, it will write the solution to standard output and then exit with an exit code of 0. When the -external solver is *unable to find a solution* (and s aware of that), it -will write an error to standard output and then exit with an exit code -of 0. An exit code other than 0 will be interpreted as a solver crash -with no meaningful error about dependency resolution to convey to the -user. +external solver is *unable to find a solution* (and is aware of that), +it will write an error to standard output and then exit with an exit +code of 0. An exit code other than 0 will be interpreted as a solver +crash with no meaningful error about dependency resolution to convey to +the user. #### Solution -- cgit v1.2.3