ref-manual: Updated the TCMODE variable.

Fixes [YOCTO #4942]

Added a note to the variable description stating that if the user
does not set TCMODE to "default", it is up to them to verify that
components are compatible with the toolchain.

(From yocto-docs rev: e67d7635c1d749e65aaef0d4cc6576a3ee312ddd)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

1 files changed, 12 insertions, 0 deletions

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 36b167940a..2e59e49f82 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -6688,6 +6688,18 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
                     internal toolchain.
                     The variable's default value is "default", which uses
                     that internal toolchain.
+                    <note>
+                        If <filename>TCMODE</filename> is set to a value
+                        other than "default", then it is your responsibility
+                        to ensure that the toolchain is compatible with the
+                        default toolchain.
+                        Using older or newer versions of these components
+                        might cause build problems.
+                        See the
+                        <ulink url='&YOCTO_RELEASE_NOTES;'>Release Notes</ulink>
+                        for the specific components with which the toolchain
+                        must be compatible.
+                    </note>
                 </para>
 
                 <para>