summaryrefslogtreecommitdiff
path: root/doc/external-installation-planer-protocol.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/external-installation-planer-protocol.txt')
-rw-r--r--doc/external-installation-planer-protocol.txt14
1 files changed, 11 insertions, 3 deletions
diff --git a/doc/external-installation-planer-protocol.txt b/doc/external-installation-planer-protocol.txt
index 7760ecf60..2a0bdbee3 100644
--- a/doc/external-installation-planer-protocol.txt
+++ b/doc/external-installation-planer-protocol.txt
@@ -162,14 +162,22 @@ The following **preference fields** are supported in request stanzas:
informational string specifying to which planer this request was send
initially.
-- *Immediate-Configuration:** (option, unset by default) A boolean value
- defining if the planer should try to configure all packages as quickly
- as possible (true) or shouldn't perform any kind of immediate
+- **Immediate-Configuration:** (option, unset by default) A boolean
+ value defining if the planer should try to configure all packages as
+ quickly as possible (true) or shouldn't perform any kind of immediate
configuration at all (false). If not explicitly set with this field
the planer is free to pick either mode or implementing e.g. a mode
which configures only packages immediately if they are flagged as
`Essential` (or are dependencies of packages marked as `Essential`).
+- **Allow-Temporary-Remove-of-Essentials** (optional, defaults to `no`).
+ A boolean value allowing the planer (if set to yes) to temporarily
+ remove an essential package. Associated with the APT::Force-LoopBreak
+ configuration option its main use is highlighting that planers who do
+ temporary removes must take special care in terms of essentials. Legit
+ uses of this option by users is very uncommon, traditionally
+ a situation in which it is needed indicates a packaging error.
+
#### Package universe