| 1 |
commit: 3f0133a1c35420f3b67284e672538699a35c59fd |
| 2 |
Author: Sam James <sam <AT> gentoo <DOT> org> |
| 3 |
AuthorDate: Fri Jan 21 19:01:07 2022 +0000 |
| 4 |
Commit: Sam James <sam <AT> gentoo <DOT> org> |
| 5 |
CommitDate: Mon Feb 21 21:39:53 2022 +0000 |
| 6 |
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=3f0133a1 |
| 7 |
|
| 8 |
general-concepts/use-flags: give guidance on IUSE defaults |
| 9 |
|
| 10 |
Avoid e.g. missing common functionality which upstream documentation |
| 11 |
may refer to/assume. |
| 12 |
|
| 13 |
Signed-off-by: Sam James <sam <AT> gentoo.org> |
| 14 |
Closes: https://github.com/gentoo/devmanual/pull/265 |
| 15 |
Signed-off-by: Sam James <sam <AT> gentoo.org> |
| 16 |
|
| 17 |
general-concepts/use-flags/text.xml | 12 ++++++++++++ |
| 18 |
1 file changed, 12 insertions(+) |
| 19 |
|
| 20 |
diff --git a/general-concepts/use-flags/text.xml b/general-concepts/use-flags/text.xml |
| 21 |
index 02f1788..0605e91 100644 |
| 22 |
--- a/general-concepts/use-flags/text.xml |
| 23 |
+++ b/general-concepts/use-flags/text.xml |
| 24 |
@@ -203,6 +203,18 @@ Add <c>+</c> or <c>-</c> before the name of the use flag in <c>IUSE</c> to turn |
| 25 |
it on or off by default. |
| 26 |
</p> |
| 27 |
|
| 28 |
+<p> |
| 29 |
+IUSE defaults should be used sparingly. Reasons to exclude/default-disable a |
| 30 |
+feature may include e.g. large build time for a dependency, or a |
| 31 |
+configuration that the Gentoo maintainer is unable to test at runtime. |
| 32 |
+</p> |
| 33 |
+ |
| 34 |
+<p> |
| 35 |
+The IUSE defaults for a package should not leave a package in a non-functional |
| 36 |
+state or lacking important, common functionality. Consulting upstream |
| 37 |
+documentation may be useful for assessing this. |
| 38 |
+</p> |
| 39 |
+ |
| 40 |
<important> |
| 41 |
Adding <c>-</c> before a flag in <c>IUSE</c> is pretty much useless, as it will |
| 42 |
neither override the user configuration (<c>make.conf</c>) nor the profile |
Archives