diff options
author | Scott Rifenbark <srifenbark@gmail.com> | 2018-07-18 13:16:05 -0700 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2018-08-15 10:28:43 +0100 |
commit | 9fc6304bf8d08d0cfdd6b4336fc7063b1363c833 (patch) | |
tree | f316b3e6fa9dd2147c0905e0fe76ef09db004a5b /documentation/ref-manual | |
parent | 55d5355b84eea118487a243e048f92e76ab3bcdf (diff) | |
download | poky-9fc6304bf8d08d0cfdd6b4336fc7063b1363c833.tar.gz |
ref-manual: Updated the SDK_TITLE variable description
Provided more detail and a cross-reference into the SDK manual
where you can change the title through the variable.
(From yocto-docs rev: 9617fa70caef48328455a02d5260e536fac19c53)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 29 |
1 files changed, 20 insertions, 9 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 9f13176d66..7ae69c0928 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -12600,22 +12600,33 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
12600 | 12600 | ||
12601 | <glossentry id='var-SDK_TITLE'><glossterm>SDK_TITLE</glossterm> | 12601 | <glossentry id='var-SDK_TITLE'><glossterm>SDK_TITLE</glossterm> |
12602 | <info> | 12602 | <info> |
12603 | SDK_TITLE[doc] = "Specifies a title to be printed when running the SDK installer." | 12603 | SDK_TITLE[doc] = "The title to be printed when running the SDK installer." |
12604 | </info> | 12604 | </info> |
12605 | <glossdef> | 12605 | <glossdef> |
12606 | <para role="glossdeffirst"> | 12606 | <para role="glossdeffirst"> |
12607 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | 12607 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> |
12608 | Specifies a title to be printed when running the SDK | 12608 | The title to be printed when running the SDK installer. |
12609 | installer. | 12609 | By default, this title is based on the |
12610 | The <filename>SDK_TITLE</filename> variable defaults to | ||
12611 | "<replaceable>distro</replaceable> SDK" for the standard | ||
12612 | SDK and "<replaceable>distro</replaceable> Extensible SDK" | ||
12613 | for the extensible SDK, where | ||
12614 | <replaceable>distro</replaceable> is the first one of | ||
12615 | <link linkend='var-DISTRO_NAME'><filename>DISTRO_NAME</filename></link> | 12610 | <link linkend='var-DISTRO_NAME'><filename>DISTRO_NAME</filename></link> |
12616 | or | 12611 | or |
12617 | <link linkend='var-DISTRO'><filename>DISTRO</filename></link> | 12612 | <link linkend='var-DISTRO'><filename>DISTRO</filename></link> |
12618 | that is set in your configuration. | 12613 | variable and is set in the |
12614 | <link linkend='ref-classes-populate-sdk-*'><filename>populate_sdk_base</filename></link> | ||
12615 | class as follows: | ||
12616 | <literallayout class='monospaced'> | ||
12617 | SDK_TITLE ??= "${@d.getVar('DISTRO_NAME') or d.getVar('DISTRO')} SDK" | ||
12618 | </literallayout> | ||
12619 | For the default distribution "poky", | ||
12620 | <filename>SDK_TITLE</filename> is set to | ||
12621 | "Poky (Yocto Project Reference Distro)". | ||
12622 | </para> | ||
12623 | |||
12624 | <para> | ||
12625 | For information on how to change this default title, | ||
12626 | see the | ||
12627 | "<ulink url='&YOCTO_DOCS_SDK_URL;#sdk-changing-the-sdk-installer-title'>Changing the Extensible SDK Installer Title</ulink>" | ||
12628 | section in the Yocto Project Application Development and | ||
12629 | the Extensible Software Development Kit (eSDK) manual. | ||
12619 | </para> | 12630 | </para> |
12620 | </glossdef> | 12631 | </glossdef> |
12621 | </glossentry> | 12632 | </glossentry> |