blob: 24e9476e6db7530f76ff8ecb1abd93e841e8e812 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
---
GLEP: 52
Title: RESTRICT=unattended
Author: Marius Mauch <genone@gentoo.org>
Type: Standards Track
Status: Withdrawn
Version: 1
Created: 2006-10-13
Last-Modified: 2014-01-23
Post-History: 2006-10-14
Content-Type: text/x-rst
---
Abstract
========
This GLEP proposes a new value for the RESTRICT metadata variable in ebuilds to
indicate that an ebuild requires interaction by the user.
Motivation
==========
Certain ebuilds in the current tree require certain actions from the user to
progress. A popular example are ebuilds that require physical media (cd/dvd-rom)
for their distfiles instead of fetching them form the net.
However ebuilds are supposed to be non-interactive, so this behavior, while
sometimes necessary, violates existing policies. To account for this situation
a new RESTRICT value should be added to allow filtering those ebuilds based on
metadata and to inform users upfront (when displaying the depgraph) that a
certain package will require their attention during the build process.
Specification
=============
Portage (and by extension other package managers) will support a new value for
the RESTRICT metadata variable called ``unattended``. This value may be used by
the package manager and tools using its API to filter packages that require
interactive actions (for example to mask them in automated build environments).
How the package manager exactly reacts on the presence of this new flag is beyond
this specification, but it's recommended to indicate it's presence to the user
whenever relevant.
This new setting should be used in ebuilds if it is known that they _typically_
require user attention during the build process. If an ebuild just has a limited
``risk`` of becoming interactive (like using the ``built_with_use`` function)
it shouldn't be restricted. Note that only package installation is covered here,
interactivity in package removals (in pkg_prerm and pkg_postrm) can not be
indicated with this feature.
Rationale
=========
The new RESTRICT=unattended metadata setting will give us the following benefits:
1. Enable masking of interactive ebuilds for automated build environments
2. Metadata based searching for interactive ebuilds (superior to grep)
3. Less frustrated users caused by ``hanging`` build processes
This proposal does not change the existing policy regarding interactive ebuilds
(ebuilds still should be non-interactive whenever possible), it merely states a
way to identify them.
Backwards Compatibility
=======================
Strictly speaking this extension would requires an EAPI bump, however as existing
portage ignore unknown RESTRICT values it shouldn't cause any real breakage to
introduce it without.
Reference Implementation
========================
A `patch against portage-2.1.2_pre2-r6`__ is available with this document.
.. __: glep-0052-extras/portage-2.1.2_pre2-r6-interactive-restrict.diff.txt
Credits
=======
Thanks to the following persons for their input on or related to this GLEP
(even though they might not have known it):
Alec Warner, Zac Medico, Simon Stelling
References
==========
.. [#bug151113] http://bugs.gentoo.org/151113
Copyright
=========
This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
Unported License. To view a copy of this license, visit
https://creativecommons.org/licenses/by-sa/3.0/.
|
GitWeb