From bf5e8e860c973fee2f6d45400af7b427038783a9 Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <srifenbark@gmail.com>
Date: Wed, 18 Jul 2018 14:08:37 -0700
Subject: sdk-manual: Edits to the section that changes the sdk title

Made some suggestions on how and where to edit the SDK_TITLE
variable.

(From yocto-docs rev: 4a4393e00c7108eefaaeaa3951a75524589bf360)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 .../sdk-manual/sdk-appendix-customizing.xml        | 23 +++++++++++++++++++---
 1 file changed, 20 insertions(+), 3 deletions(-)

(limited to 'documentation/sdk-manual')

diff --git a/documentation/sdk-manual/sdk-appendix-customizing.xml b/documentation/sdk-manual/sdk-appendix-customizing.xml
index 0335fe0908..7b03e6fc94 100644
--- a/documentation/sdk-manual/sdk-appendix-customizing.xml
+++ b/documentation/sdk-manual/sdk-appendix-customizing.xml
@@ -187,6 +187,12 @@
         the
         <ulink url='&YOCTO_DOCS_REF_URL;#var-SDK_TITLE'><filename>SDK_TITLE</filename></ulink>
         variable and then rebuilding the the SDK installer.
+        For information on how to build an SDK installer, see the
+        "<link linkend='sdk-building-an-sdk-installer'>Building an SDK Installer</link>"
+        section.
+    </para>
+
+    <para>
         By default, this title is derived from
         <ulink url='&YOCTO_DOCS_REF_URL;#var-DISTRO_NAME'><filename>DISTRO_NAME</filename></ulink>
         when it is set.
@@ -207,9 +213,20 @@
     </para>
 
     <para>
-        For information on how to build an SDK installer, see the
-        "<link linkend='sdk-building-an-sdk-installer'>Building an SDK Installer</link>"
-        section.
+        While several ways exist to change this variable, an efficient method
+        is to set the variable in your distribution's configuration file.
+        Doing so creates an SDK installer title that applies across your
+        distribution.
+        As an example, assume you have your own layer for your distribution
+        named "meta-mydistro" and you are using the same type of file
+        hierarchy as does the default "poky" distribution.
+        If so, you could update the <filename>SDK_TITLE</filename> variable
+        in the
+        <filename>~/meta-mydistro/conf/distro/mydistro.conf</filename> file
+        using the following form:
+        <literallayout class='monospaced'>
+     SDK_TITLE = "<replaceable>your_title</replaceable>"
+        </literallayout>
     </para>
 </section>
 
-- 
cgit v1.2.3-54-g00ecf