From c60a06bc65ab01aa56643185b3cb95d25fa83b68 Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <srifenbark@gmail.com>
Date: Mon, 21 May 2018 09:08:59 -0700
Subject: sdk-manual: Edits to section on running the sdk installation script

I changed the way we handle the list of exported variables resulting
from running the *.sh installation script.  Rather than list them
all out (they were getting to be quite numerous), I am referencing a
few as examples and recommending the user look at the actual *.sh file
if they would like to examine the entire list.

(From yocto-docs rev: fa60c255a12bd3dd79da4a77c3150937eeb4e201)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 documentation/sdk-manual/sdk-extensible.xml | 21 +++++++++++++++------
 1 file changed, 15 insertions(+), 6 deletions(-)

(limited to 'documentation/sdk-manual')

diff --git a/documentation/sdk-manual/sdk-extensible.xml b/documentation/sdk-manual/sdk-extensible.xml
index de0e7a7379..f23ecc8043 100644
--- a/documentation/sdk-manual/sdk-extensible.xml
+++ b/documentation/sdk-manual/sdk-extensible.xml
@@ -205,10 +205,11 @@
      SDK environment now set up; additionally you may now run devtool to perform development tasks.
      Run devtool --help for further details.
             </literallayout>
+<!--
             Running the setup script defines many environment variables:
             <literallayout class='monospaced'>
      <ulink url='&YOCTO_DOCS_REF_URL;#var-AR'><filename>AR</filename></ulink> - The minimal command and arguments to run 'ar'
-<!--     ARCH - missing this one.  It gets set in meta/recipes-devtools/python/python3-native_3.5.5.bb (ARCH=${TARGET_ARCH}) -->
+     ARCH - missing this one.  It gets set in meta/recipes-devtools/python/python3-native_3.5.5.bb (ARCH=${TARGET_ARCH})
      <ulink url='&YOCTO_DOCS_REF_URL;#var-AS'><filename>AS</filename></ulink> - The minimal command and arguments to run the assembler
      <ulink url='&YOCTO_DOCS_REF_URL;#var-CC'><filename>CC</filename></ulink> - The minimal command and arguments to run the C compiler
      <ulink url='&YOCTO_DOCS_REF_URL;#var-CFLAGS'><filename>CFLAGS</filename></ulink> - Suggested C flags
@@ -220,27 +221,35 @@
      <ulink url='&YOCTO_DOCS_REF_URL;#var-CXXFLAGS'><filename>CXXFLAGS</filename></ulink> - Suggested C++ flags
      <ulink url='&YOCTO_DOCS_REF_URL;#var-DEPLOY_DIR_IMAGE'><filename>DEPLOY_DIR_IMAGE</filename></ulink>
      <ulink url='&YOCTO_DOCS_REF_URL;#var-GDB'><filename>GDB</filename></ulink> - The minimal command and arguments to run the GNU Debugger
-<!--     KCFLAGS - missing this one.  It appears once in meta/classes/toolchain-scripts.bbclass -->
+     KCFLAGS - missing this one.  It appears once in meta/classes/toolchain-scripts.bbclass
      <ulink url='&YOCTO_DOCS_REF_URL;#var-LD'><filename>LD</filename></ulink> - The minimal command and arguments to run the linker
      <ulink url='&YOCTO_DOCS_REF_URL;#var-LDFLAGS'><filename>LDFLAGS</filename></ulink> - Suggested linker flags when you use CC to link
-<!--     M4 - missing this one.  It appears once in meta/recipes-devtools/flex/flex_2.6.0.bb -->
+     M4 - missing this one.  It appears once in meta/recipes-devtools/flex/flex_2.6.0.bb
      <ulink url='&YOCTO_DOCS_REF_URL;#var-NM'><filename>NM</filename></ulink> - The minimal command and arguments to run 'nm'
      <ulink url='&YOCTO_DOCS_REF_URL;#var-OBJCOPY'><filename>OBJCOPY</filename></ulink> - The minimal command and arguments to run 'objcopy'
      <ulink url='&YOCTO_DOCS_REF_URL;#var-OBJDUMP'><filename>OBJDUMP</filename></ulink> - The minimal command and arguments to run 'objdump'
-<!--     OE_SKIP_SDK_CHECK - missing this one.  It appears in meta/classes/populate_sdk_ext.bbclass
+     OE_SKIP_SDK_CHECK - missing this one.  It appears in meta/classes/populate_sdk_ext.bbclass
      OECORE_ACLOCAL_OPTS - missing this one.  It appears in meta/classes/toolchain-scripts.bbclass
      OECORE_DISTRO_VERSION - missing this one.  It appears in meta/classes/toolchain-scripts.bbclass
      OECORE_NATIVE_SYSROOT - missing this one.  It appears in meta/classes/toolchain-scripts.bbclass
      OECORE_SDK_VERSION - missing this one.  It appears in meta/classes/toolchain-scripts.bbclass
-     OECORE_TARGET_SYSROOT - missing this one.  It appears in meta/classes/toolchain-scripts.bbclass -->
+     OECORE_TARGET_SYSROOT - missing this one.  It appears in meta/classes/toolchain-scripts.bbclass
      PATH - The Linux variable that specifies the set of directories where executable programs are located.
      <ulink url='&YOCTO_DOCS_REF_URL;#var-PKG_CONFIG_PATH'><filename>PKG_CONFIG_PATH</filename></ulink> - The path to the target pkg-config files
-<!--     PKG_CONFIG_SYSROOT_DIR - missing this one.  It appears in meta/classes/cross-canadian.bbclass:export PKG_CONFIG_SYSROOT_DIR = "${STAGING_DIR_HOST}" -->
+     PKG_CONFIG_SYSROOT_DIR - missing this one.  It appears in meta/classes/cross-canadian.bbclass:export PKG_CONFIG_SYSROOT_DIR = "${STAGING_DIR_HOST}"
      <ulink url='&YOCTO_DOCS_REF_URL;#var-RANLIB'><filename>RANLIB</filename></ulink> - The minimal command and arguments to run 'ranlib'
      <ulink url='&YOCTO_DOCS_REF_URL;#var-SDKTARGETSYSROOT'><filename>SDKTARGETSYSROOT</filename></ulink> - The path to the sysroot used for cross-compilation
      <ulink url='&YOCTO_DOCS_REF_URL;#var-STRIP'><filename>STRIP</filename></ulink> - The minimal command and arguments to run strip, which is used to strip symbols.
      <ulink url='&YOCTO_DOCS_REF_URL;#var-TARGET_PREFIX'><filename>TARGET_PREFIX</filename></ulink> - The toolchain binary prefix for the target tools
             </literallayout>
+-->
+        Running the setup script defines many environment variables needed in
+        order to use the SDK (e.g. <filename>PATH</filename>,
+        <ulink url='&YOCTO_DOCS_REF_URL;#var-CC'><filename>CC</filename></ulink>,
+        <ulink url='&YOCTO_DOCS_REF_URL;#var-LD'><filename>LD</filename></ulink>,
+        and so forth).
+        If you want to see all the environment variables the script exports,
+        examine the installation file itself.
         </para>
     </section>
 
-- 
cgit v1.2.3-54-g00ecf