diff options
| -rw-r--r-- | documentation/ref-manual/variables.rst | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 3a33b3543c..861b04eaab 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
| @@ -4597,6 +4597,60 @@ system and gives an overview of their function and contents. | |||
| 4597 | ":ref:`kernel-dev/common:using an "in-tree" \`\`defconfig\`\` file`" | 4597 | ":ref:`kernel-dev/common:using an "in-tree" \`\`defconfig\`\` file`" |
| 4598 | section in the Yocto Project Linux Kernel Development Manual. | 4598 | section in the Yocto Project Linux Kernel Development Manual. |
| 4599 | 4599 | ||
| 4600 | :term:`KCONF_AUDIT_LEVEL` | ||
| 4601 | When inheriting the :ref:`ref-classes-kernel-yocto` class and when the | ||
| 4602 | :term:`KMETA_AUDIT` variable is set to a non-empty string, the | ||
| 4603 | :term:`KCONF_AUDIT_LEVEL` variable specifies whether to report Kernel | ||
| 4604 | configuration values that are different from the user-specified value. Its | ||
| 4605 | value is a positive integer (default: 1): | ||
| 4606 | |||
| 4607 | - 0: no reporting is done. | ||
| 4608 | |||
| 4609 | - 1: report the problems as warnings and trigger an error if | ||
| 4610 | :term:`KMETA_AUDIT_WERROR` is set. | ||
| 4611 | |||
| 4612 | - 2: if the :ref:`ref-tasks-kernel_configme` has failed to generate a | ||
| 4613 | ``.config`` file, print the content of the ``merge_config_build.log`` | ||
| 4614 | file containing the errors, instead of just providing the path to | ||
| 4615 | that file. | ||
| 4616 | |||
| 4617 | For more details see the :ref:`ref-classes-kernel-yocto` class and the | ||
| 4618 | :yocto_git:`symbol_why.py </yocto-kernel-tools/tree/tools/symbol_why.py>` | ||
| 4619 | script in :yocto_git:`yocto-kernel-tools </yocto-kernel-tools>`. | ||
| 4620 | |||
| 4621 | :term:`KCONF_BSP_AUDIT_LEVEL` | ||
| 4622 | When inheriting the :ref:`ref-classes-kernel-yocto` class and when the | ||
| 4623 | :term:`KMETA_AUDIT` variable is set to a non-empty string, the | ||
| 4624 | :term:`KCONF_BSP_AUDIT_LEVEL` variable can be set to report: | ||
| 4625 | |||
| 4626 | #. User-specified Kernel configurations that did not make it into the final | ||
| 4627 | Kernel configuration. | ||
| 4628 | |||
| 4629 | #. Configurations defined in multiple input files with differing values. | ||
| 4630 | |||
| 4631 | Its value is a positive integer (default: 0): | ||
| 4632 | |||
| 4633 | - 0: no reporting is done. | ||
| 4634 | |||
| 4635 | - 1: reporting of configuration options that did not make it in the | ||
| 4636 | final configuration is done and is not limited to the current | ||
| 4637 | architecture (``ARCH``) in use. | ||
| 4638 | |||
| 4639 | - 2: reporting of configuration options that did not make it in the | ||
| 4640 | final configuration is done and is strictly limited to the current | ||
| 4641 | architecture (``ARCH``) in use. | ||
| 4642 | |||
| 4643 | - 3: report the problems found when this variable equals 2, and also | ||
| 4644 | report configurations options defined in multiple input files with | ||
| 4645 | differing values. | ||
| 4646 | |||
| 4647 | For value 1, 2 and 3 an error is produced if :term:`KMETA_AUDIT_WERROR` | ||
| 4648 | is set. | ||
| 4649 | |||
| 4650 | For more details see the :ref:`ref-classes-kernel-yocto` class and the | ||
| 4651 | :yocto_git:`symbol_why.py </yocto-kernel-tools/tree/tools/symbol_why.py>` | ||
| 4652 | script in :yocto_git:`yocto-kernel-tools </yocto-kernel-tools>`. | ||
| 4653 | |||
| 4600 | :term:`KCONFIG_MODE` | 4654 | :term:`KCONFIG_MODE` |
| 4601 | When used with the :ref:`ref-classes-kernel-yocto` | 4655 | When used with the :ref:`ref-classes-kernel-yocto` |
| 4602 | class, specifies the kernel configuration values to use for options | 4656 | class, specifies the kernel configuration values to use for options |
| @@ -5001,6 +5055,20 @@ system and gives an overview of their function and contents. | |||
| 5001 | However, the OpenEmbedded build system understands the machine as | 5055 | However, the OpenEmbedded build system understands the machine as |
| 5002 | "core2-32-intel-common". | 5056 | "core2-32-intel-common". |
| 5003 | 5057 | ||
| 5058 | :term:`KMETA_AUDIT` | ||
| 5059 | When inheriting the :ref:`ref-classes-kernel-yocto` class, the | ||
| 5060 | :term:`KMETA_AUDIT` variable enables or disables auditing of Linux Kernel | ||
| 5061 | configuration. The default value for this variable is "yes", and auditing | ||
| 5062 | is enabled. Set this variable to an empty string to disable auditing. | ||
| 5063 | |||
| 5064 | :term:`KMETA_AUDIT_WERROR` | ||
| 5065 | When inheriting the :ref:`ref-classes-kernel-yocto` class and when the | ||
| 5066 | :term:`KMETA_AUDIT` and the :term:`KMETA_AUDIT_WERROR` variables are set | ||
| 5067 | to non-empty strings, produce an error if Linux kernel configuration | ||
| 5068 | problems were detected, instead of warnings only. For more details on the | ||
| 5069 | Linux Kernel configuration auditing feature, see :term:`KCONF_AUDIT_LEVEL` | ||
| 5070 | and :term:`KCONF_BSP_AUDIT_LEVEL`. | ||
| 5071 | |||
| 5004 | :term:`KTYPE` | 5072 | :term:`KTYPE` |
| 5005 | Defines the kernel type to be used in assembling the configuration. | 5073 | Defines the kernel type to be used in assembling the configuration. |
| 5006 | The linux-yocto recipes define "standard", "tiny", and "preempt-rt" | 5074 | The linux-yocto recipes define "standard", "tiny", and "preempt-rt" |
