diff options
Diffstat (limited to 'documentation/ref-manual/ref-variables.xml')
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 314 |
1 files changed, 277 insertions, 37 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 7606c9c799..8284c73868 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -2447,6 +2447,35 @@ | |||
2447 | </glossdef> | 2447 | </glossdef> |
2448 | </glossentry> | 2448 | </glossentry> |
2449 | 2449 | ||
2450 | <glossentry id='var-COREBASE_FILES'><glossterm>COREBASE_FILES</glossterm> | ||
2451 | <info> | ||
2452 | COREBASE_FILES[doc] = "Lists files from the COREBASE directory that should be copied other than the layers listed in the bblayers.conf file." | ||
2453 | </info> | ||
2454 | <glossdef> | ||
2455 | <para role="glossdeffirst"> | ||
2456 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | ||
2457 | Lists files from the | ||
2458 | <link linkend='var-COREBASE'><filename>COREBASE</filename></link> | ||
2459 | directory that should be copied other than the layers | ||
2460 | listed in the <filename>bblayers.conf</filename> file. | ||
2461 | The <filename>COREBASE_FILES</filename> variable exists | ||
2462 | for the purpose of copying metadata from the | ||
2463 | OpenEmbedded build system into the extensible | ||
2464 | SDK. | ||
2465 | </para> | ||
2466 | |||
2467 | <para> | ||
2468 | Copying these files is needed because | ||
2469 | <filename>COREBASE</filename> typically contains build | ||
2470 | directories and other files that should not normally | ||
2471 | be copied into the extensible SDK. | ||
2472 | Consequently, the value of | ||
2473 | <filename>COREBASE_FILES</filename> is used in order to | ||
2474 | only copy the files that are actually needed. | ||
2475 | </para> | ||
2476 | </glossdef> | ||
2477 | </glossentry> | ||
2478 | |||
2450 | <glossentry id='var-CPP'><glossterm>CPP</glossterm> | 2479 | <glossentry id='var-CPP'><glossterm>CPP</glossterm> |
2451 | <info> | 2480 | <info> |
2452 | CPP[doc] = "Minimum command and arguments to run the C preprocessor." | 2481 | CPP[doc] = "Minimum command and arguments to run the C preprocessor." |
@@ -5899,6 +5928,43 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
5899 | </glossdef> | 5928 | </glossdef> |
5900 | </glossentry> | 5929 | </glossentry> |
5901 | 5930 | ||
5931 | <glossentry id='var-INHERIT'><glossterm>INHERIT</glossterm> | ||
5932 | <info> | ||
5933 | INHERIT[doc] = "Causes the named class to be inherited at this point during parsing. The variable is only valid in configuration files." | ||
5934 | </info> | ||
5935 | <glossdef> | ||
5936 | <para role="glossdeffirst"> | ||
5937 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | ||
5938 | Causes the named class to be inherited at | ||
5939 | this point during parsing. | ||
5940 | The variable is only valid in configuration files. | ||
5941 | </para> | ||
5942 | </glossdef> | ||
5943 | </glossentry> | ||
5944 | |||
5945 | <glossentry id='var-INHERIT_DISTRO'><glossterm>INHERIT_DISTRO</glossterm> | ||
5946 | <info> | ||
5947 | INHERIT_DISTRO[doc] = "Lists classes that will be inherited at the distribution level. It is unlikely that you want to edit this variable." | ||
5948 | </info> | ||
5949 | <glossdef> | ||
5950 | <para role="glossdeffirst"> | ||
5951 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | ||
5952 | Lists classes that will be inherited at the | ||
5953 | distribution level. | ||
5954 | It is unlikely that you want to edit this variable. | ||
5955 | </para> | ||
5956 | |||
5957 | <para> | ||
5958 | The default value of the variable is set as follows in the | ||
5959 | <filename>meta/conf/distro/defaultsetup.conf</filename> | ||
5960 | file: | ||
5961 | <literallayout class='monospaced'> | ||
5962 | INHERIT_DISTRO ?= "debian devshell sstate license" | ||
5963 | </literallayout> | ||
5964 | </para> | ||
5965 | </glossdef> | ||
5966 | </glossentry> | ||
5967 | |||
5902 | <glossentry id='var-INHIBIT_DEFAULT_DEPS'><glossterm>INHIBIT_DEFAULT_DEPS</glossterm> | 5968 | <glossentry id='var-INHIBIT_DEFAULT_DEPS'><glossterm>INHIBIT_DEFAULT_DEPS</glossterm> |
5903 | <info> | 5969 | <info> |
5904 | INHIBIT_DEFAULT_DEPS[doc] = "Prevents the default dependencies, namely the C compiler and standard C library (libc), from being added to DEPENDS." | 5970 | INHIBIT_DEFAULT_DEPS[doc] = "Prevents the default dependencies, namely the C compiler and standard C library (libc), from being added to DEPENDS." |
@@ -5963,43 +6029,6 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
5963 | </glossdef> | 6029 | </glossdef> |
5964 | </glossentry> | 6030 | </glossentry> |
5965 | 6031 | ||
5966 | <glossentry id='var-INHERIT'><glossterm>INHERIT</glossterm> | ||
5967 | <info> | ||
5968 | INHERIT[doc] = "Causes the named class to be inherited at this point during parsing. The variable is only valid in configuration files." | ||
5969 | </info> | ||
5970 | <glossdef> | ||
5971 | <para role="glossdeffirst"> | ||
5972 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | ||
5973 | Causes the named class to be inherited at | ||
5974 | this point during parsing. | ||
5975 | The variable is only valid in configuration files. | ||
5976 | </para> | ||
5977 | </glossdef> | ||
5978 | </glossentry> | ||
5979 | |||
5980 | <glossentry id='var-INHERIT_DISTRO'><glossterm>INHERIT_DISTRO</glossterm> | ||
5981 | <info> | ||
5982 | INHERIT_DISTRO[doc] = "Lists classes that will be inherited at the distribution level. It is unlikely that you want to edit this variable." | ||
5983 | </info> | ||
5984 | <glossdef> | ||
5985 | <para role="glossdeffirst"> | ||
5986 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | ||
5987 | Lists classes that will be inherited at the | ||
5988 | distribution level. | ||
5989 | It is unlikely that you want to edit this variable. | ||
5990 | </para> | ||
5991 | |||
5992 | <para> | ||
5993 | The default value of the variable is set as follows in the | ||
5994 | <filename>meta/conf/distro/defaultsetup.conf</filename> | ||
5995 | file: | ||
5996 | <literallayout class='monospaced'> | ||
5997 | INHERIT_DISTRO ?= "debian devshell sstate license" | ||
5998 | </literallayout> | ||
5999 | </para> | ||
6000 | </glossdef> | ||
6001 | </glossentry> | ||
6002 | |||
6003 | <glossentry id='var-INITRAMFS_FSTYPES'><glossterm>INITRAMFS_FSTYPES</glossterm> | 6032 | <glossentry id='var-INITRAMFS_FSTYPES'><glossterm>INITRAMFS_FSTYPES</glossterm> |
6004 | <info> | 6033 | <info> |
6005 | INITRAMFS_FSTYPES[doc] = "Defines the format for the output image of an initial RAM disk (initramfs), which is used during boot." | 6034 | INITRAMFS_FSTYPES[doc] = "Defines the format for the output image of an initial RAM disk (initramfs), which is used during boot." |
@@ -8202,6 +8231,28 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
8202 | </glossdef> | 8231 | </glossdef> |
8203 | </glossentry> | 8232 | </glossentry> |
8204 | 8233 | ||
8234 | <glossentry id='var-OE_INIT_ENV_SCRIPT'><glossterm>OE_INIT_ENV_SCRIPT</glossterm> | ||
8235 | <info> | ||
8236 | OE_INIT_ENV_SCRIPT[doc] = "The name of the build environment setup script for the purposes of setting up the environment within the extensible SDK." | ||
8237 | </info> | ||
8238 | <glossdef> | ||
8239 | <para role="glossdeffirst"> | ||
8240 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | ||
8241 | The name of the build environment setup script for the | ||
8242 | purposes of setting up the environment within the | ||
8243 | extensible SDK. | ||
8244 | The default value is "oe-init-build-env". | ||
8245 | </para> | ||
8246 | |||
8247 | <para> | ||
8248 | If you use a custom script to set up your build | ||
8249 | environment, set the | ||
8250 | <filename>OE_INIT_ENV_SCRIPT</filename> variable to its | ||
8251 | name. | ||
8252 | </para> | ||
8253 | </glossdef> | ||
8254 | </glossentry> | ||
8255 | |||
8205 | <glossentry id='var-OE_TERMINAL'><glossterm>OE_TERMINAL</glossterm> | 8256 | <glossentry id='var-OE_TERMINAL'><glossterm>OE_TERMINAL</glossterm> |
8206 | <info> | 8257 | <info> |
8207 | OE_TERMINAL[doc] = "Controls how the OpenEmbedded build system spawns interactive terminals on the host development system." | 8258 | OE_TERMINAL[doc] = "Controls how the OpenEmbedded build system spawns interactive terminals on the host development system." |
@@ -10673,6 +10724,30 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
10673 | </glossdef> | 10724 | </glossdef> |
10674 | </glossentry> | 10725 | </glossentry> |
10675 | 10726 | ||
10727 | <glossentry id='var-SDK_EXT_TYPE'><glossterm>SDK_EXT_TYPE</glossterm> | ||
10728 | <info> | ||
10729 | SDK_EXT_TYPE[doc] = "Specifies the required shared state artifacts for the extensible SDK." | ||
10730 | </info> | ||
10731 | <glossdef> | ||
10732 | <para role="glossdeffirst"> | ||
10733 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | ||
10734 | Specifies the required shared state artifacts for the | ||
10735 | extensible SDK. | ||
10736 | The default value of "full" copies all of the required | ||
10737 | shared state artifacts into the extensible SDK. | ||
10738 | The value "minimal" leaves these artifacts out of the | ||
10739 | SDK. | ||
10740 | <note> | ||
10741 | If you set the variable to "minimal", you need to | ||
10742 | ensure | ||
10743 | <link linkend='var-SSTATE_MIRRORS'><filename>SSTATE_MIRRORS</filename></link> | ||
10744 | is set in the SDK's configuration to enable the | ||
10745 | artifacts to be fetched as needed. | ||
10746 | </note> | ||
10747 | </para> | ||
10748 | </glossdef> | ||
10749 | </glossentry> | ||
10750 | |||
10676 | <glossentry id='var-SDK_HOST_MANIFEST'><glossterm>SDK_HOST_MANIFEST</glossterm> | 10751 | <glossentry id='var-SDK_HOST_MANIFEST'><glossterm>SDK_HOST_MANIFEST</glossterm> |
10677 | <info> | 10752 | <info> |
10678 | SDK_HOST_MANIFEST[doc] = "The manifest file for the host part of the SDK. This file lists all the installed packages that make up the host part of the SDK." | 10753 | SDK_HOST_MANIFEST[doc] = "The manifest file for the host part of the SDK. This file lists all the installed packages that make up the host part of the SDK." |
@@ -10706,6 +10781,88 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
10706 | </glossdef> | 10781 | </glossdef> |
10707 | </glossentry> | 10782 | </glossentry> |
10708 | 10783 | ||
10784 | <glossentry id='var-SDK_INCLUDE_PKGDATA'><glossterm>SDK_INCLUDE_PKGDATA</glossterm> | ||
10785 | <info> | ||
10786 | SDK_INCLUDE_PKGDATA[doc] = "When set to "1", specifies to include the packagedata for all recipes in the "world" target in the extensible SDK." | ||
10787 | </info> | ||
10788 | <glossdef> | ||
10789 | <para role="glossdeffirst"> | ||
10790 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | ||
10791 | When set to "1", specifies to include the packagedata for | ||
10792 | all recipes in the "world" target in the extensible SDK. | ||
10793 | Including this data allows the | ||
10794 | <filename>devtool search</filename> command to find these | ||
10795 | recipes in search results, as well as allows the | ||
10796 | <filename>devtool add</filename> command to map | ||
10797 | dependencies more effectively. | ||
10798 | <note> | ||
10799 | Enabling the <filename>SDK_INCLUDE_PKGDATA</filename> | ||
10800 | variable significantly increases build time because | ||
10801 | all of world needs to be built. | ||
10802 | Enabling the variable also slightly increases the size | ||
10803 | of the extensible SDK. | ||
10804 | </note> | ||
10805 | </para> | ||
10806 | </glossdef> | ||
10807 | </glossentry> | ||
10808 | |||
10809 | <glossentry id='var-SDK_INHERIT_BLACKLIST'><glossterm>SDK_INHERIT_BLACKLIST</glossterm> | ||
10810 | <info> | ||
10811 | SDK_INHERIT_BLACKLIST[doc] = "A list of classes to remove from the INHERIT value globally within the extensible SDK configuration." | ||
10812 | </info> | ||
10813 | <glossdef> | ||
10814 | <para role="glossdeffirst"> | ||
10815 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | ||
10816 | A list of classes to remove from the | ||
10817 | <link linkend='var-INHERIT'><filename>INHERIT</filename></link> | ||
10818 | value globally within the extensible SDK configuration. | ||
10819 | The default value is "buildhistory icecc". | ||
10820 | </para> | ||
10821 | |||
10822 | <para> | ||
10823 | Some classes are not generally applicable within | ||
10824 | the extensible SDK context and you can use this variable | ||
10825 | to disable them. | ||
10826 | </para> | ||
10827 | </glossdef> | ||
10828 | </glossentry> | ||
10829 | |||
10830 | <glossentry id='var-SDK_LOCAL_CONF_BLACKLIST'><glossterm>SDK_LOCAL_CONF_BLACKLIST</glossterm> | ||
10831 | <info> | ||
10832 | SDK_LOCAL_CONF_BLACKLIST[doc] = "A list of variables allowed through from the build system configuration into the extensible SDK configuration." | ||
10833 | </info> | ||
10834 | <glossdef> | ||
10835 | <para role="glossdeffirst"> | ||
10836 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | ||
10837 | A list of variables allowed through from the build system | ||
10838 | configuration into the extensible SDK configuration. | ||
10839 | Usually, these are variables that are specific to the | ||
10840 | machine on which the build system is running and thus | ||
10841 | would be potentially problematic within the extensible SDK. | ||
10842 | </para> | ||
10843 | </glossdef> | ||
10844 | </glossentry> | ||
10845 | |||
10846 | <glossentry id='var-SDK_LOCAL_CONF_WHITELIST'><glossterm>SDK_LOCAL_CONF_WHITELIST</glossterm> | ||
10847 | <info> | ||
10848 | SDK_LOCAL_CONF_WHITELIST[doc] = "A list of variables allowed through from the build system configuration into the extensible SDK configuration." | ||
10849 | </info> | ||
10850 | <glossdef> | ||
10851 | <para role="glossdeffirst"> | ||
10852 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | ||
10853 | A list of variables allowed through from the build system | ||
10854 | configuration into the extensible SDK configuration. | ||
10855 | This list overrides the variables specified using the | ||
10856 | <link linkend='var-SDK_LOCAL_CONF_BLACKLIST'><filename>SDK_LOCAL_CONF_BLACKLIST</filename></link> | ||
10857 | variable as well as any variables identified by automatic | ||
10858 | blacklisting due to the "/" character being found at the | ||
10859 | start of the value, which is usually indicative of being a | ||
10860 | path and thus might not be valid on the system where the | ||
10861 | SDK is installed. | ||
10862 | </para> | ||
10863 | </glossdef> | ||
10864 | </glossentry> | ||
10865 | |||
10709 | <glossentry id='var-SDK_NAME'><glossterm>SDK_NAME</glossterm> | 10866 | <glossentry id='var-SDK_NAME'><glossterm>SDK_NAME</glossterm> |
10710 | <info> | 10867 | <info> |
10711 | SDK_NAME[doc] = "The base name for SDK output files." | 10868 | SDK_NAME[doc] = "The base name for SDK output files." |
@@ -10837,6 +10994,31 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
10837 | </glossdef> | 10994 | </glossdef> |
10838 | </glossentry> | 10995 | </glossentry> |
10839 | 10996 | ||
10997 | <glossentry id='var-SDK_RECRDEP_TASKS'><glossterm>SDK_RECRDEP_TASKS</glossterm> | ||
10998 | <info> | ||
10999 | SDK_RECRDEP_TASKS[doc] = "A list of shared state tasks added to the extensible SDK." | ||
11000 | </info> | ||
11001 | <glossdef> | ||
11002 | <para role="glossdeffirst"> | ||
11003 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | ||
11004 | A list of shared state tasks added to the extensible SDK. | ||
11005 | The default value is "" and adds the following tasks to | ||
11006 | the SDK: | ||
11007 | <literallayout class='monospaced'> | ||
11008 | do_populate_lic | ||
11009 | do_package_qa | ||
11010 | do_populate_sysroot | ||
11011 | do_deploy | ||
11012 | </literallayout> | ||
11013 | If you are defining additional tasks that are needed in | ||
11014 | order to build | ||
11015 | <link linkend='var-SDK_TARGETS'><filename>SDK_TARGETS</filename></link>, | ||
11016 | use the <filename>SDK_RECRDEP_TASKS</filename> variable to | ||
11017 | specify them. | ||
11018 | </para> | ||
11019 | </glossdef> | ||
11020 | </glossentry> | ||
11021 | |||
10840 | <glossentry id='var-SDK_SYS'><glossterm>SDK_SYS</glossterm> | 11022 | <glossentry id='var-SDK_SYS'><glossterm>SDK_SYS</glossterm> |
10841 | <info> | 11023 | <info> |
10842 | SDK_SYS[doc] = "Specifies the system, including the architecture and the operating system, for which the SDK will be built." | 11024 | SDK_SYS[doc] = "Specifies the system, including the architecture and the operating system, for which the SDK will be built." |
@@ -10894,6 +11076,64 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
10894 | </glossdef> | 11076 | </glossdef> |
10895 | </glossentry> | 11077 | </glossentry> |
10896 | 11078 | ||
11079 | <glossentry id='var-SDK_TARGETS'><glossterm>SDK_TARGETS</glossterm> | ||
11080 | <info> | ||
11081 | SDK_TARGETS[doc] = "A list of targets to install from shared state as part of the standard or extensible SDK installation." | ||
11082 | </info> | ||
11083 | <glossdef> | ||
11084 | <para role="glossdeffirst"> | ||
11085 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | ||
11086 | A list of targets to install from shared state as part of | ||
11087 | the standard or extensible SDK installation. | ||
11088 | The default value is "${PN}" (i.e. the image from which | ||
11089 | the SDK is built). | ||
11090 | </para> | ||
11091 | |||
11092 | <para> | ||
11093 | The <filename>SDK_TARGETS</filename> variable is an | ||
11094 | internal variable and typically would not be changed. | ||
11095 | </para> | ||
11096 | </glossdef> | ||
11097 | </glossentry> | ||
11098 | |||
11099 | <glossentry id='var-SDK_TITLE'><glossterm>SDK_TITLE</glossterm> | ||
11100 | <info> | ||
11101 | SDK_TITLE[doc] = "Specifies a title to be printed when running the SDK installer." | ||
11102 | </info> | ||
11103 | <glossdef> | ||
11104 | <para role="glossdeffirst"> | ||
11105 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | ||
11106 | Specifies a title to be printed when running the SDK | ||
11107 | installer. | ||
11108 | The <filename>SDK_TITLE</filename> variable defaults to | ||
11109 | "<replaceable>distro</replaceable> SDK" for the standard | ||
11110 | SDK and "<replaceable>distro</replaceable> Extensible SDK" | ||
11111 | for the extensible SDK, where | ||
11112 | <replaceable>distro</replaceable> is the first one of | ||
11113 | <link linkend='var-DISTRO_NAME'><filename>DISTRO_NAME</filename></link> | ||
11114 | or | ||
11115 | <link linkend='var-DISTRO'><filename>DISTRO</filename></link> | ||
11116 | that is set in your configuration. | ||
11117 | </para> | ||
11118 | </glossdef> | ||
11119 | </glossentry> | ||
11120 | |||
11121 | <glossentry id='var-SDK_UPDATE_URL'><glossterm>SDK_UPDATE_URL</glossterm> | ||
11122 | <info> | ||
11123 | SDK_UPDATE_URL[doc] = "An optional URL for an update server for the extensible SDK." | ||
11124 | </info> | ||
11125 | <glossdef> | ||
11126 | <para role="glossdeffirst"> | ||
11127 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | ||
11128 | An optional URL for an update server for the extensible | ||
11129 | SDK. | ||
11130 | If set, the value is used as the default update server when | ||
11131 | running <filename>devtool sdk-update</filename> within the | ||
11132 | extensible SDK. | ||
11133 | </para> | ||
11134 | </glossdef> | ||
11135 | </glossentry> | ||
11136 | |||
10897 | <glossentry id='var-SDK_VENDOR'><glossterm>SDK_VENDOR</glossterm> | 11137 | <glossentry id='var-SDK_VENDOR'><glossterm>SDK_VENDOR</glossterm> |
10898 | <info> | 11138 | <info> |
10899 | SDK_VENDOR[doc] = "Specifies the name of the SDK vendor." | 11139 | SDK_VENDOR[doc] = "Specifies the name of the SDK vendor." |