diff options
Diffstat (limited to 'documentation/ref-manual/variables.rst')
-rw-r--r-- | documentation/ref-manual/variables.rst | 89 |
1 files changed, 2 insertions, 87 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index a6962bb9d4..d8e6a81ea7 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -9,7 +9,7 @@ system and gives an overview of their function and contents. | |||
9 | 9 | ||
10 | :term:`A <ABIEXTENSION>` :term:`B` :term:`C <CACHE>` | 10 | :term:`A <ABIEXTENSION>` :term:`B` :term:`C <CACHE>` |
11 | :term:`D` :term:`E <EFI_PROVIDER>` :term:`F <FAKEROOT>` | 11 | :term:`D` :term:`E <EFI_PROVIDER>` :term:`F <FAKEROOT>` |
12 | :term:`G <GCCPIE>` :term:`H <HGDIR>` :term:`I <ICECC_CLASS_DISABLE>` | 12 | :term:`G <GCCPIE>` :term:`H <HGDIR>` :term:`I <IMAGE_BASENAME>` |
13 | :term:`K <KARCH>` :term:`L <LABELS>` :term:`M <MACHINE>` | 13 | :term:`K <KARCH>` :term:`L <LABELS>` :term:`M <MACHINE>` |
14 | :term:`N <NATIVELSBSTRING>` :term:`O <OBJCOPY>` :term:`P` | 14 | :term:`N <NATIVELSBSTRING>` :term:`O <OBJCOPY>` :term:`P` |
15 | :term:`Q <QA_EMPTY_DIRS>` :term:`R <RANLIB>` :term:`S` :term:`T` | 15 | :term:`Q <QA_EMPTY_DIRS>` :term:`R <RANLIB>` :term:`S` :term:`T` |
@@ -2686,7 +2686,7 @@ system and gives an overview of their function and contents. | |||
2686 | :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class sets the | 2686 | :ref:`populate-sdk-ext <ref-classes-populate-sdk-*>` class sets the |
2687 | default value:: | 2687 | default value:: |
2688 | 2688 | ||
2689 | ESDK_CLASS_INHERIT_DISABLE ?= "buildhistory icecc" | 2689 | ESDK_CLASS_INHERIT_DISABLE ?= "buildhistory" |
2690 | 2690 | ||
2691 | Some classes are not generally applicable within the extensible SDK | 2691 | Some classes are not generally applicable within the extensible SDK |
2692 | context. You can use this variable to disable those classes. | 2692 | context. You can use this variable to disable those classes. |
@@ -3818,91 +3818,6 @@ system and gives an overview of their function and contents. | |||
3818 | :term:`HOSTTOOLS_NONFATAL` is not found on the build host. Thus, you can | 3818 | :term:`HOSTTOOLS_NONFATAL` is not found on the build host. Thus, you can |
3819 | use :term:`HOSTTOOLS_NONFATAL` to filter optional host tools. | 3819 | use :term:`HOSTTOOLS_NONFATAL` to filter optional host tools. |
3820 | 3820 | ||
3821 | :term:`ICECC_CLASS_DISABLE` | ||
3822 | Identifies user classes that you do not want the Icecream distributed | ||
3823 | compile support to consider. This variable is used by the | ||
3824 | :ref:`ref-classes-icecc` class. You set this variable in | ||
3825 | your ``local.conf`` file. | ||
3826 | |||
3827 | When you list classes using this variable, the recipes inheriting | ||
3828 | those classes will not benefit from distributed compilation across | ||
3829 | remote hosts. Instead they will be built locally. | ||
3830 | |||
3831 | :term:`ICECC_DISABLED` | ||
3832 | Disables or enables the ``icecc`` (Icecream) function. For more | ||
3833 | information on this function and best practices for using this | ||
3834 | variable, see the ":ref:`ref-classes-icecc`" | ||
3835 | section. | ||
3836 | |||
3837 | Setting this variable to "1" in your ``local.conf`` disables the | ||
3838 | function:: | ||
3839 | |||
3840 | ICECC_DISABLED ??= "1" | ||
3841 | |||
3842 | To enable the function, set the variable as follows:: | ||
3843 | |||
3844 | ICECC_DISABLED = "" | ||
3845 | |||
3846 | :term:`ICECC_ENV_EXEC` | ||
3847 | Points to the ``icecc-create-env`` script that you provide. This | ||
3848 | variable is used by the :ref:`ref-classes-icecc` class. You | ||
3849 | set this variable in your ``local.conf`` file. | ||
3850 | |||
3851 | If you do not point to a script that you provide, the OpenEmbedded | ||
3852 | build system uses the default script provided by the | ||
3853 | :oe_git:`icecc-create-env_0.1.bb | ||
3854 | </openembedded-core/tree/meta/recipes-devtools/icecc-create-env/icecc-create-env_0.1.bb>` | ||
3855 | recipe, which is a modified version and not the one that comes with | ||
3856 | ``icecream``. | ||
3857 | |||
3858 | :term:`ICECC_PARALLEL_MAKE` | ||
3859 | Extra options passed to the ``make`` command during the | ||
3860 | :ref:`ref-tasks-compile` task that specify parallel | ||
3861 | compilation. This variable usually takes the form of "-j x", where x | ||
3862 | represents the maximum number of parallel threads ``make`` can run. | ||
3863 | |||
3864 | .. note:: | ||
3865 | |||
3866 | The options passed affect builds on all enabled machines on the | ||
3867 | network, which are machines running the ``iceccd`` daemon. | ||
3868 | |||
3869 | If your enabled machines support multiple cores, coming up with the | ||
3870 | maximum number of parallel threads that gives you the best | ||
3871 | performance could take some experimentation since machine speed, | ||
3872 | network lag, available memory, and existing machine loads can all | ||
3873 | affect build time. Consequently, unlike the | ||
3874 | :term:`PARALLEL_MAKE` variable, there is no | ||
3875 | rule-of-thumb for setting :term:`ICECC_PARALLEL_MAKE` to achieve optimal | ||
3876 | performance. | ||
3877 | |||
3878 | If you do not set :term:`ICECC_PARALLEL_MAKE`, the build system does not | ||
3879 | use it (i.e. the system does not detect and assign the number of | ||
3880 | cores as is done with :term:`PARALLEL_MAKE`). | ||
3881 | |||
3882 | :term:`ICECC_PATH` | ||
3883 | The location of the ``icecc`` binary. You can set this variable in | ||
3884 | your ``local.conf`` file. If your ``local.conf`` file does not define | ||
3885 | this variable, the :ref:`ref-classes-icecc` class attempts | ||
3886 | to define it by locating ``icecc`` using ``which``. | ||
3887 | |||
3888 | :term:`ICECC_RECIPE_DISABLE` | ||
3889 | Identifies user recipes that you do not want the Icecream distributed | ||
3890 | compile support to consider. This variable is used by the | ||
3891 | :ref:`ref-classes-icecc` class. You set this variable in | ||
3892 | your ``local.conf`` file. | ||
3893 | |||
3894 | When you list recipes using this variable, you are excluding them | ||
3895 | from distributed compilation across remote hosts. Instead they will | ||
3896 | be built locally. | ||
3897 | |||
3898 | :term:`ICECC_RECIPE_ENABLE` | ||
3899 | Identifies user recipes that use an empty | ||
3900 | :term:`PARALLEL_MAKE` variable that you want to | ||
3901 | force remote distributed compilation on using the Icecream | ||
3902 | distributed compile support. This variable is used by the | ||
3903 | :ref:`ref-classes-icecc` class. You set this variable in | ||
3904 | your ``local.conf`` file. | ||
3905 | |||
3906 | :term:`IMAGE_BASENAME` | 3821 | :term:`IMAGE_BASENAME` |
3907 | The base name of image output files. This variable defaults to the | 3822 | The base name of image output files. This variable defaults to the |
3908 | recipe name (``${``\ :term:`PN`\ ``}``). | 3823 | recipe name (``${``\ :term:`PN`\ ``}``). |