Build Docs

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

arch interface

avb_algorithm string, Signing algorithm for avbtool. Default is SHA256_RSA4096.

avb_hash_algorithm string, Hash algorithm used for avbtool (for descriptors). This is passed as hash_algorithm to avbtool. Default used by avbtool is sha1.

avb_private_key string, Path to the private key that avbtool will use to sign this filesystem image. TODO(jiyong): allow apex_key to be specified here

base_dir string, Base directory relative to root, to which deps are installed, e.g. "system". Default is "." (root).

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

debug_ramdisk bool, Whether this module is installed to debug ramdisk

deps list of string

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

dirs list of string, Directories to be created under root. e.g. /dev, /proc, etc.

dists list of Dist, a list of configurations to distribute output files from this module to the distribution directory (default: $OUT/dist, configurable with $DIST_DIR)

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.

fake_timestamp string, Seconds since unix epoch to override timestamps of file entries

file_contexts string, file_contexts file to make image. Currently, only ext4 is supported.

host_required list of string, names of other modules to install on host if this module is installed

init_rc list of string, init.rc files to be installed if this module is installed

licenses list of string, Describes the licenses applicable to this module. Must reference license modules.

multilib interface

native_bridge_supported bool, Whether this module is built for non-native architectures (also known as native bridge binary)

owner string, vendor who owns this module

partition_name string, Name of the partition stored in vbmeta desc. Defaults to the name of 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 string, 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).

symlinks list of symlinkDefinition, Symbolic links to be created under root with "ln -sf <target> <name>".

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

type string, Type of the filesystem. Currently, ext4, cpio, and compressed_cpio are supported. Default is ext4.

use_avb bool, When set to true, sign the image with avbtool. Default is false.

uuid string, When set, passed to mkuserimg_mke2fs --mke2fs_uuid & --mke2fs_hash_seed. Otherwise, they'll be set as random which might cause indeterministic build output.

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.

vendor_ramdisk bool, Whether this module is installed to vendor ramdisk

vintf_fragments list of string, VINTF manifest fragments to be installed if this module is installed

visibility list of string, 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.