Build Docs

name string, The name of the module. Must be unique across all modules.

srcs list of strings, list of source (.py) files compatible both with Python2 and Python3 used to compile the Python module. srcs may reference the outputs of other modules that produce source files like genrule or filegroup using the syntax ":module". Srcs has to be non-empty.

arch interface

auto_gen_config bool, Flag to indicate whether or not to create test config automatically. If AndroidTest.xml doesn't exist next to the Android.bp, this attribute doesn't need to be set to true explicitly.

autorun bool, whether to use `main` when starting the executable. The default is true, when set to false it will act much like the normal `python` executable, but with the sources and libraries automatically included in the PYTHONPATH.

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

data list of strings, list of files or filegroup modules that provide data that should be installed alongside the test. the file extension can be arbitrary except for (.py).

defaults list of strings

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`.

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, list of source files that should not be used to build the C/C++ module. This is most useful in the arch/multilib variants to remove non-common files

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

is_internal bool, true, if the Python module is used internally, eg, Python std libs.

libs list of strings, list of the Python libraries compatible both with Python2 and Python3.

licenses list of strings, Names of the licenses that apply to this module.

main string, the name of the source file that is the main entry point of the program. this file must also be listed in srcs. If left unspecified, module name is used instead. If name doesn’t match any filename in srcs, main must be specified.

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

pkg_path string, the package path prefix within the output artifact at which to place the source/data files of the current module. eg. Pkg_path = "a/b/c"; Other packages can reference this module by using (from a.b.c import ...) statement. if left unspecified, all the source/data files path is unchanged within zip file.

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).

stem string, set the name of the output binary.

suffix string, append to the name of the output binary.

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_required list of strings, names of other modules to install on target if this module is installed

test_suites list of strings, list of compatibility suites (for example "cts", "vts") that the module should be installed into.

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.

name string, The name of the module. Must be unique across all modules.

srcs list of strings, list of source (.py) files compatible both with Python2 and Python3 used to compile the Python module. srcs may reference the outputs of other modules that produce source files like genrule or filegroup using the syntax ":module". Srcs has to be non-empty.

host_supported bool, If set to true, build a variant of the module for the host. Defaults to false.

device_supported bool, If set to true, build a variant of the module for the device. Defaults to true.

apex_available list of strings, Availability of this module in APEXes. Only the listed APEXes can contain this module. If the module has stubs then other APEXes and the platform may access it through them (subject to visibility). "//apex_available:anyapex" is a pseudo APEX name that matches to any APEX. "//apex_available:platform" refers to non-APEX partitions like "system.img". Default is ["//apex_available:platform"].

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

data list of strings, list of files or filegroup modules that provide data that should be installed alongside the test. the file extension can be arbitrary except for (.py).

defaults list of strings

defaults_visibility list of strings, Controls the visibility of the defaults module itself.