[gentoo-commits] repo/gentoo:master commit in: eclass/

[Sam James]

commit:     571dd66bedd32f3f5fdf4a1609e2edfa3b76a0e9
Author:     David Seifert <soap <AT> gentoo <DOT> org>
AuthorDate: Sun May 15 17:10:57 2022 +0000
Commit:     Sam James <sam <AT> gentoo <DOT> org>
CommitDate: Mon May 16 23:28:51 2022 +0000
URL:        https://gitweb.gentoo.org/repo/gentoo.git/commit/?id=571dd66b

toolchain-funcs.eclass: document proper tc-check-openmp use

Signed-off-by: David Seifert <soap <AT> gentoo.org>
Closes: https://github.com/gentoo/gentoo/pull/25498
Signed-off-by: Sam James <sam <AT> gentoo.org>

 eclass/toolchain-funcs.eclass | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/eclass/toolchain-funcs.eclass b/eclass/toolchain-funcs.eclass
index 9ad5e224b03e..54d4b0912a6e 100644
--- a/eclass/toolchain-funcs.eclass
+++ b/eclass/toolchain-funcs.eclass
@@ -611,6 +611,19 @@ tc-has-openmp() {
 # OpenMP support that has been requested by the ebuild. Using this function
 # to test for OpenMP support should be preferred over tc-has-openmp and
 # printing a custom message, as it presents a uniform interface to the user.
+#
+# You should test for any necessary OpenMP support in pkg_pretend in order to
+# warn the user of required toolchain changes.  You must still check for OpenMP
+# support at build-time, e.g.
+# @CODE
+# pkg_pretend() {
+#	[[ ${MERGE_TYPE} != binary ]] && use openmp && tc-check-openmp
+# }
+#
+# pkg_setup() {
+#	[[ ${MERGE_TYPE} != binary ]] && use openmp && tc-check-openmp
+# }
+# @CODE
 tc-check-openmp() {
 	if ! _tc-has-openmp; then
 		eerror "Your current compiler does not support OpenMP!"