GLEP 52: RESTRICT=unattended
|Author||Marius Mauch <firstname.lastname@example.org>|
This GLEP proposes a new value for the RESTRICT metadata variable in ebuilds to indicate that an ebuild requires interaction by the user.
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.
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.
The new RESTRICT=unattended metadata setting will give us the following benefits:
- Enable masking of interactive ebuilds for automated build environments
- Metadata based searching for interactive ebuilds (superior to grep)
- 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.
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.
A patch against portage-2.1.2_pre2-r6 is available with this document.
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
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/.