csuite_config

csuite_config generates an App Compatibility Test Suite (C-Suite) configuration file from the <test_config> xml file and stores it in a subdirectory of $(HOST_OUT).
name , arch , compile_multilib , device_specific , dist , enabled , host_required , init_rc , licenses , multilib , native_bridge_supported , notice , owner , product_specific , proprietary , ramdisk , recovery , required , soc_specific , system_ext_specific , target , target.host , target_required , test_config , vendor , vintf_fragments , visibility
 name string, The name of the module. Must be unique across all modules.
 arch interface
 compile_multilib string, control whether this module compiles for 32-bit, 64-bit, or both. Possible values are "32" (compile for 32-bit only), "64" (compile for 64-bit only), "both" (compile for both architectures), or "first" (compile for 64-bit on a 64-bit platform, and 32-bit on a 32-bit platform
 device_specific bool, whether this module is specific to a device, not only for SoC, but also for off-chip peripherals. When set to true, it is installed into /odm (or /vendor/odm if odm partition does not exist, or /system/vendor/odm if both odm and vendor partitions do not exist). This implies `soc_specific:true`.
⊕dist
 targets list of strings, copy the output of this module to the $DIST_DIR when `dist` is specified on the command line and any of these targets are also on the command line, or otherwise built
 dest string, The name of the output artifact. This defaults to the basename of the output of the module.
 dir string, The directory within the dist directory to store the artifact. Defaults to the top level directory ("").
 suffix string, A suffix to add to the artifact file name (before any extension).
 enabled bool, emit build rules for this module Disabling a module should only be done for those modules that cannot be built in the current environment. Modules that can build in the current environment but are not usually required (e.g. superceded by a prebuilt) should not be disabled as that will prevent them from being built by the checkbuild target and so prevent early detection of changes that have broken those modules.
 host_required list of strings, names of other modules to install on host if this module is installed
 init_rc list of strings, init.rc files to be installed if this module is installed
 licenses list of strings, Names of the licenses that apply to this module.
 multilib interface
 native_bridge_supported bool, Whether this module is built for non-native architecures (also known as native bridge binary)
 notice string, relative path to a file to include in the list of notices for the device
 owner string, vendor who owns this module
 product_specific bool, whether this module is specific to a software configuration of a product (e.g. country, network operator, etc). When set to true, it is installed into /product (or /system/product if product partition does not exist).
 proprietary bool, whether this is a proprietary vendor module, and should be installed into /vendor
 ramdisk bool, Whether this module is installed to ramdisk
 recovery bool, Whether this module is installed to recovery partition
 required list of strings, names of other modules to install if this module is installed
 soc_specific bool, whether this module is specific to an SoC (System-On-a-Chip). When set to true, it is installed into /vendor (or /system/vendor if vendor partition does not exist).
 system_ext_specific bool, whether this module extends system. When set to true, it is installed into /system_ext (or /system/system_ext if system_ext partition does not exist).
 target interface
⊕target.host, target.android
 compile_multilib string
 target_required list of strings, names of other modules to install on target if this module is installed
 test_config string, Override the default (AndroidTest.xml) test manifest file name.
 vendor bool, whether this module is specific to an SoC (System-On-a-Chip). When set to true, it is installed into /vendor (or /system/vendor if vendor partition does not exist). Use `soc_specific` instead for better meaning.
 vintf_fragments list of strings, VINTF manifest fragments to be installed if this module is installed
 visibility list of strings, Controls the visibility of this module to other modules. Allowable values are one or more of these formats: 

 ["//visibility:public"]: Anyone can use this module.
 ["//visibility:private"]: Only rules in the module's package (not its subpackages) can use
     this module.
 ["//visibility:override"]: Discards any rules inherited from defaults or a creating module.
     Can only be used at the beginning of a list of visibility rules.
 ["//some/package:__pkg__", "//other/package:__pkg__"]: Only modules in some/package and
     other/package (defined in some/package/*.bp and other/package/*.bp) have access to
     this module. Note that sub-packages do not have access to the rule; for example,
     //some/package/foo:bar or //other/package/testing:bla wouldn't have access. __pkg__
     is a special module and must be used verbatim. It represents all of the modules in the
     package.
 ["//project:__subpackages__", "//other:__subpackages__"]: Only modules in packages project
     or other or in one of their sub-packages have access to this module. For example,
     //project:rule, //project/library:lib or //other/testing/internal:munge are allowed
     to depend on this rule (but not //independent:evil)
 ["//project"]: This is shorthand for ["//project:__pkg__"]
 [":__subpackages__"]: This is shorthand for ["//project:__subpackages__"] where
     //project is the module's package. e.g. using [":__subpackages__"] in
     packages/apps/Settings/Android.bp is equivalent to
     //packages/apps/Settings:__subpackages__.
 ["//visibility:legacy_public"]: The default visibility, behaves as //visibility:public
     for now. It is an error if it is used in a module.
If a module does not specify the `visibility` property then it uses the `default_visibility` property of the `package` module in the module's package. If the `default_visibility` property is not set for the module's package then it will use the `default_visibility` of its closest ancestor package for which a `default_visibility` property is specified. If no `default_visibility` property can be found then the module uses the global default of `//visibility:legacy_public`. The `visibility` property has no effect on a defaults module although it does apply to any non-defaults module that uses it. To set the visibility of a defaults module, use the `defaults_visibility` property on the defaults module; not to be confused with the `default_visibility` property on the package module. See https://android.googlesource.com/platform/build/soong/+/master/README.md#visibility for more details.

filegroup

filegroup contains a list of files that are referenced by other modules properties (such as "srcs") using the syntax ":<name>". filegroup are also be used to export files across package boundaries.
name , srcs , compile_multilib , device_specific , dist , enabled , exclude_srcs , export_to_make_var , host_required , init_rc , licenses , native_bridge_supported , notice , owner , path , product_specific , proprietary , ramdisk , recovery , required , soc_specific , system_ext_specific , target.host , target_required , vendor , vintf_fragments , visibility
 name string, The name of the module. Must be unique across all modules.
 srcs list of strings, srcs lists files that will be included in this filegroup
 compile_multilib string, control whether this module compiles for 32-bit, 64-bit, or both. Possible values are "32" (compile for 32-bit only), "64" (compile for 64-bit only), "both" (compile for both architectures), or "first" (compile for 64-bit on a 64-bit platform, and 32-bit on a 32-bit platform
 device_specific bool, whether this module is specific to a device, not only for SoC, but also for off-chip peripherals. When set to true, it is installed into /odm (or /vendor/odm if odm partition does not exist, or /system/vendor/odm if both odm and vendor partitions do not exist). This implies `soc_specific:true`.
⊕dist
 targets list of strings, copy the output of this module to the $DIST_DIR when `dist` is specified on the command line and any of these targets are also on the command line, or otherwise built
 dest string, The name of the output artifact. This defaults to the basename of the output of the module.
 dir string, The directory within the dist directory to store the artifact. Defaults to the top level directory ("").
 suffix string, A suffix to add to the artifact file name (before any extension).
 enabled bool, emit build rules for this module Disabling a module should only be done for those modules that cannot be built in the current environment. Modules that can build in the current environment but are not usually required (e.g. superceded by a prebuilt) should not be disabled as that will prevent them from being built by the checkbuild target and so prevent early detection of changes that have broken those modules.
 exclude_srcs list of strings
 export_to_make_var string, Create a make variable with the specified name that contains the list of files in the filegroup, relative to the root of the source tree.
 host_required list of strings, names of other modules to install on host if this module is installed
 init_rc list of strings, init.rc files to be installed if this module is installed
 licenses list of strings, Names of the licenses that apply to this module.
 native_bridge_supported bool, Whether this module is built for non-native architecures (also known as native bridge binary)
 notice string, relative path to a file to include in the list of notices for the device
 owner string, vendor who owns this module
 path string, The base path to the files. May be used by other modules to determine which portion of the path to use. For example, when a filegroup is used as data in a cc_test rule, the base path is stripped off the path and the remaining path is used as the installation directory.
 product_specific bool, whether this module is specific to a software configuration of a product (e.g. country, network operator, etc). When set to true, it is installed into /product (or /system/product if product partition does not exist).
 proprietary bool, whether this is a proprietary vendor module, and should be installed into /vendor
 ramdisk bool, Whether this module is installed to ramdisk
 recovery bool, Whether this module is installed to recovery partition
 required list of strings, names of other modules to install if this module is installed
 soc_specific bool, whether this module is specific to an SoC (System-On-a-Chip). When set to true, it is installed into /vendor (or /system/vendor if vendor partition does not exist).
 system_ext_specific bool, whether this module extends system. When set to true, it is installed into /system_ext (or /system/system_ext if system_ext partition does not exist).
⊕target.host, target.android
 compile_multilib string
 target_required list of strings, names of other modules to install on target if this module is installed
 vendor bool, whether this module is specific to an SoC (System-On-a-Chip). When set to true, it is installed into /vendor (or /system/vendor if vendor partition does not exist). Use `soc_specific` instead for better meaning.
 vintf_fragments list of strings, VINTF manifest fragments to be installed if this module is installed
 visibility list of strings, Controls the visibility of this module to other modules. Allowable values are one or more of these formats: 

 ["//visibility:public"]: Anyone can use this module.
 ["//visibility:private"]: Only rules in the module's package (not its subpackages) can use
     this module.
 ["//visibility:override"]: Discards any rules inherited from defaults or a creating module.
     Can only be used at the beginning of a list of visibility rules.
 ["//some/package:__pkg__", "//other/package:__pkg__"]: Only modules in some/package and
     other/package (defined in some/package/*.bp and other/package/*.bp) have access to
     this module. Note that sub-packages do not have access to the rule; for example,
     //some/package/foo:bar or //other/package/testing:bla wouldn't have access. __pkg__
     is a special module and must be used verbatim. It represents all of the modules in the
     package.
 ["//project:__subpackages__", "//other:__subpackages__"]: Only modules in packages project
     or other or in one of their sub-packages have access to this module. For example,
     //project:rule, //project/library:lib or //other/testing/internal:munge are allowed
     to depend on this rule (but not //independent:evil)
 ["//project"]: This is shorthand for ["//project:__pkg__"]
 [":__subpackages__"]: This is shorthand for ["//project:__subpackages__"] where
     //project is the module's package. e.g. using [":__subpackages__"] in
     packages/apps/Settings/Android.bp is equivalent to
     //packages/apps/Settings:__subpackages__.
 ["//visibility:legacy_public"]: The default visibility, behaves as //visibility:public
     for now. It is an error if it is used in a module.
If a module does not specify the `visibility` property then it uses the `default_visibility` property of the `package` module in the module's package. If the `default_visibility` property is not set for the module's package then it will use the `default_visibility` of its closest ancestor package for which a `default_visibility` property is specified. If no `default_visibility` property can be found then the module uses the global default of `//visibility:legacy_public`. The `visibility` property has no effect on a defaults module although it does apply to any non-defaults module that uses it. To set the visibility of a defaults module, use the `defaults_visibility` property on the defaults module; not to be confused with the `default_visibility` property on the package module. See https://android.googlesource.com/platform/build/soong/+/master/README.md#visibility for more details.

license

name , copyright_notice , defaults , license_kinds , license_text , package_name , visibility
 name string, The name of the module. Must be unique across all modules.
 copyright_notice string, Specifies a short copyright notice to use for the license.
 defaults list of strings
 license_kinds list of strings, Specifies the kinds of license that apply.
 license_text list of strings, Specifies the path or label for the text of the license.
 package_name string, Specifies the package name to which the license applies.
 visibility list of strings, Specifies where this license can be used

package

default_applicable_licenses , default_visibility
 default_applicable_licenses list of strings, Specifies the names of the default licenses for all modules defined in this package.
 default_visibility list of strings, Specifies the default visibility for all modules defined in this package.

soong_config_bool_variable

soong_config_string_variable defines a variable with true or false values for use in a soong_config_module_type definition.
name
 name string

soong_config_module_type

soong_config_module_type defines module types with conditionals on Soong config variables. The new module type will exist for all modules after the definition in an Android.bp file, and can be imported into other Android.bp files using soong_config_module_type_import. For example, an Android.bp file could have: 

    soong_config_module_type {
        name: "acme_cc_defaults",
        module_type: "cc_defaults",
        config_namespace: "acme",
        variables: ["board"],
        bool_variables: ["feature"],
        value_variables: ["width"],
        properties: ["cflags", "srcs"],
    }

    soong_config_string_variable {
        name: "board",
        values: ["soc_a", "soc_b"],
    }

    acme_cc_defaults {
        name: "acme_defaults",
        cflags: ["-DGENERIC"],
        soong_config_variables: {
            board: {
                soc_a: {
                    cflags: ["-DSOC_A"],
                },
                soc_b: {
                    cflags: ["-DSOC_B"],
                },
            },
            feature: {
                cflags: ["-DFEATURE"],
            },
            width: {
	               cflags: ["-DWIDTH=%s"],
            },
        },
    }

    cc_library {
        name: "libacme_foo",
        defaults: ["acme_defaults"],
        srcs: ["*.cpp"],
    }
If an acme BoardConfig.mk file contained: 

    SOONG_CONFIG_NAMESPACES += acme
    SOONG_CONFIG_acme += \
        board \
        feature \

    SOONG_CONFIG_acme_board := soc_a
    SOONG_CONFIG_acme_feature := true
    SOONG_CONFIG_acme_width := 200
Then libacme_foo would build with cflags "-DGENERIC -DSOC_A -DFEATURE".
name , bool_variables , config_namespace , module_type , properties , value_variables , variables
 name string, the name of the new module type. Unlike most modules, this name does not need to be unique, although only one module type with any name will be importable into an Android.bp file.
 bool_variables list of strings, the list of boolean SOONG_CONFIG variables that this module type will read
 config_namespace string, the SOONG_CONFIG_NAMESPACE value from a BoardConfig.mk that this module type will read configuration variables from.
 module_type string, the module type that this module type will extend.
 properties list of strings, the list of properties that this module type will extend.
 value_variables list of strings, the list of SOONG_CONFIG variables that this module type will read. The value will be inserted into the properties with %s substitution.
 variables list of strings, the list of SOONG_CONFIG variables that this module type will read

soong_config_module_type_import

soong_config_module_type_import imports module types with conditionals on Soong config variables from another Android.bp file. The imported module type will exist for all modules after the import in the Android.bp file. For example, an Android.bp file could have: 

    soong_config_module_type_import {
        from: "device/acme/Android.bp",
        module_types: ["acme_cc_defaults"],
    }

    acme_cc_defaults {
        name: "acme_defaults",
        cflags: ["-DGENERIC"],
        soong_config_variables: {
            board: {
                soc_a: {
                    cflags: ["-DSOC_A"],
                },
                soc_b: {
                    cflags: ["-DSOC_B"],
                },
            },
            feature: {
                cflags: ["-DFEATURE"],
            },
            width: {
                cflags: ["-DWIDTH=%s"],
            },
        },
    }

    cc_library {
        name: "libacme_foo",
        defaults: ["acme_defaults"],
        srcs: ["*.cpp"],
    }
And device/acme/Android.bp could have: 

    soong_config_module_type {
        name: "acme_cc_defaults",
        module_type: "cc_defaults",
        config_namespace: "acme",
        variables: ["board"],
        bool_variables: ["feature"],
        value_variables: ["width"],
        properties: ["cflags", "srcs"],
    }

    soong_config_string_variable {
        name: "board",
        values: ["soc_a", "soc_b"],
    }
If an acme BoardConfig.mk file contained: 

    SOONG_CONFIG_NAMESPACES += acme
    SOONG_CONFIG_acme += \
        board \
        feature \

    SOONG_CONFIG_acme_board := soc_a
    SOONG_CONFIG_acme_feature := true
    SOONG_CONFIG_acme_width := 200
Then libacme_foo would build with cflags "-DGENERIC -DSOC_A -DFEATURE -DWIDTH=200".
from , module_types
 from string
 module_types list of strings

soong_config_string_variable

soong_config_string_variable defines a variable and a set of possible string values for use in a soong_config_module_type definition.
name , values
 name string
 values list of strings

soong_namespace

soong_namespace provides a scope to modules in an Android.bp file to prevent module name conflicts with other defined modules in different Android.bp files. Once soong_namespace has been defined in an Android.bp file, the namespacing is applied to all modules that follow the soong_namespace in the current Android.bp file, as well as modules defined in Android.bp files in subdirectories. An Android.bp file in a subdirectory can define its own soong_namespace which is applied to all its modules and as well as modules defined in subdirectories Android.bp files. Modules in a soong_namespace are visible to Make by listing the namespace path in PRODUCT_SOONG_NAMESPACES make variable in a makefile.
imports
 imports list of strings, a list of namespaces that contain modules that will be referenced by modules in this namespace.

vts_config

vts_config generates a Vendor Test Suite (VTS10) configuration file from the <test_config> xml file and stores it in a subdirectory of $(HOST_OUT).
name , arch , compile_multilib , device_specific , dist , enabled , host_required , init_rc , licenses , multilib , native_bridge_supported , notice , owner , product_specific , proprietary , ramdisk , recovery , required , soc_specific , system_ext_specific , target , target.host , target_required , test_config , test_suites , vendor , vintf_fragments , visibility
 name string, The name of the module. Must be unique across all modules.
 arch interface
 compile_multilib string, control whether this module compiles for 32-bit, 64-bit, or both. Possible values are "32" (compile for 32-bit only), "64" (compile for 64-bit only), "both" (compile for both architectures), or "first" (compile for 64-bit on a 64-bit platform, and 32-bit on a 32-bit platform
 device_specific bool, whether this module is specific to a device, not only for SoC, but also for off-chip peripherals. When set to true, it is installed into /odm (or /vendor/odm if odm partition does not exist, or /system/vendor/odm if both odm and vendor partitions do not exist). This implies `soc_specific:true`.
⊕dist
 targets list of strings, copy the output of this module to the $DIST_DIR when `dist` is specified on the command line and any of these targets are also on the command line, or otherwise built
 dest string, The name of the output artifact. This defaults to the basename of the output of the module.
 dir string, The directory within the dist directory to store the artifact. Defaults to the top level directory ("").
 suffix string, A suffix to add to the artifact file name (before any extension).
 enabled bool, emit build rules for this module Disabling a module should only be done for those modules that cannot be built in the current environment. Modules that can build in the current environment but are not usually required (e.g. superceded by a prebuilt) should not be disabled as that will prevent them from being built by the checkbuild target and so prevent early detection of changes that have broken those modules.
 host_required list of strings, names of other modules to install on host if this module is installed
 init_rc list of strings, init.rc files to be installed if this module is installed
 licenses list of strings, Names of the licenses that apply to this module.
 multilib interface
 native_bridge_supported bool, Whether this module is built for non-native architecures (also known as native bridge binary)
 notice string, relative path to a file to include in the list of notices for the device
 owner string, vendor who owns this module
 product_specific bool, whether this module is specific to a software configuration of a product (e.g. country, network operator, etc). When set to true, it is installed into /product (or /system/product if product partition does not exist).
 proprietary bool, whether this is a proprietary vendor module, and should be installed into /vendor
 ramdisk bool, Whether this module is installed to ramdisk
 recovery bool, Whether this module is installed to recovery partition
 required list of strings, names of other modules to install if this module is installed
 soc_specific bool, whether this module is specific to an SoC (System-On-a-Chip). When set to true, it is installed into /vendor (or /system/vendor if vendor partition does not exist).
 system_ext_specific bool, whether this module extends system. When set to true, it is installed into /system_ext (or /system/system_ext if system_ext partition does not exist).
 target interface
⊕target.host, target.android
 compile_multilib string
 target_required list of strings, names of other modules to install on target if this module is installed
 test_config string, Override the default (AndroidTest.xml) test manifest file name.
 test_suites list of strings, Additional test suites to add the test to.
 vendor bool, whether this module is specific to an SoC (System-On-a-Chip). When set to true, it is installed into /vendor (or /system/vendor if vendor partition does not exist). Use `soc_specific` instead for better meaning.
 vintf_fragments list of strings, VINTF manifest fragments to be installed if this module is installed
 visibility list of strings, Controls the visibility of this module to other modules. Allowable values are one or more of these formats: 

 ["//visibility:public"]: Anyone can use this module.
 ["//visibility:private"]: Only rules in the module's package (not its subpackages) can use
     this module.
 ["//visibility:override"]: Discards any rules inherited from defaults or a creating module.
     Can only be used at the beginning of a list of visibility rules.
 ["//some/package:__pkg__", "//other/package:__pkg__"]: Only modules in some/package and
     other/package (defined in some/package/*.bp and other/package/*.bp) have access to
     this module. Note that sub-packages do not have access to the rule; for example,
     //some/package/foo:bar or //other/package/testing:bla wouldn't have access. __pkg__
     is a special module and must be used verbatim. It represents all of the modules in the
     package.
 ["//project:__subpackages__", "//other:__subpackages__"]: Only modules in packages project
     or other or in one of their sub-packages have access to this module. For example,
     //project:rule, //project/library:lib or //other/testing/internal:munge are allowed
     to depend on this rule (but not //independent:evil)
 ["//project"]: This is shorthand for ["//project:__pkg__"]
 [":__subpackages__"]: This is shorthand for ["//project:__subpackages__"] where
     //project is the module's package. e.g. using [":__subpackages__"] in
     packages/apps/Settings/Android.bp is equivalent to
     //packages/apps/Settings:__subpackages__.
 ["//visibility:legacy_public"]: The default visibility, behaves as //visibility:public
     for now. It is an error if it is used in a module.
If a module does not specify the `visibility` property then it uses the `default_visibility` property of the `package` module in the module's package. If the `default_visibility` property is not set for the module's package then it will use the `default_visibility` of its closest ancestor package for which a `default_visibility` property is specified. If no `default_visibility` property can be found then the module uses the global default of `//visibility:legacy_public`. The `visibility` property has no effect on a defaults module although it does apply to any non-defaults module that uses it. To set the visibility of a defaults module, use the `defaults_visibility` property on the defaults module; not to be confused with the `default_visibility` property on the package module. See https://android.googlesource.com/platform/build/soong/+/master/README.md#visibility for more details.