******************
Variables Glossary
******************

This chapter lists common variables used in the CoreOS build
system and gives an overview of their function and contents.

Variables provided by OpenEmbedded-Core are documented in the
:external:doc:`Yocto Reference Manual <ref-manual/variables>`.


.. glossary::
    :sorted:

    :term:`COREOS_ROOT`

        Specifies the root directory of CoreOS.

        It is an important distinction that :term:`COREOS_ROOT` points to root of
        the Git repository of CoreOS, and not to a layer.

    :term:`COREOS_METADATA_BRANCH`

        The branch currently checked out for the CoreOS project (path
        determined by :term:`COREOS_ROOT`).
    
    :term:`COREOS_METADATA_REVISION`

        The revision currently checked out for the CoreOS project (path
        determined by :term:`COREOS_ROOT`).
    
    :term:`COREOS_EFI_SECUREBOOT__KEYDIR`

        Path to the directory containing the private and public key used for
        signing and authenticating UEFI binary.
        
        The `coreos-init-buildenv` will automatically generate the keys in
        `build/keys`. The default variables of `COREOS_EFI_SECUREBOOT__KEYDIR`
        default to use this directory.

    :term:`COREOS_EFI_SECUREBOOT_INSTALL_PUBKEY_IN_EFIDIR`

        If the distro or the machine configuration ihnerit the
        `coreos-efi-secureboot` class, settings this variables to `"1"` inside
        the machine configuration will automatically install all the public key
        needed for secure boot in the EFI partition.

        This is intended to be use when using CoreOS on machine that already
        come with a built-in EFI compliant firmware, to ease the import of 
        the needed certificate into the firmware.
        
        For machine that use a CoreOS provided firmware (u-boot), the public key
        are already shipped inside the firmware binary.