Build Docs

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

srcs list of strings, path to the main source file that contains the program entry point (e.g. src/main.rs)

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.

androidMkDylibs list of strings

androidMkProcMacroLibs list of strings

androidMkRlibs list of strings

androidMkSharedLibs list of strings

androidMkStaticLibs list of strings

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

crate_name string, crate name, required for libraries. This must be the expected extern crate name used in source

defaults list of strings

deny_warnings bool, whether to pass "-D warnings" to rustc. Defaults to true.

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

dylibs list of strings, list of rust dylib crate dependencies

edition string, specific rust edition that should be used if the default version is not desired

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.

features list of strings, list of features to enable for this crate

flags list of strings, flags to pass to rustc

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

ld_flags list of strings, flags to pass to the linker

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)

no_stdlibs bool, whether to suppress inclusion of standard crates - defaults to false

notice string, relative path to a file to include in the list of notices for the device

owner string, vendor who owns this module

prefer_dynamic bool, passes -C prefer-dynamic to rustc, which tells it to dynamically link the stdlib (assuming it has no dylib dependencies already)

proc_macros list of strings, list of rust proc_macro crate dependencies

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

relative_install_path string, install to a subdirectory of the default install path for the module

required list of strings, names of other modules to install if this module is installed

rlibs list of strings, list of rust rlib crate dependencies

shared_libs list of strings, list of C shared library dependencies

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

static_libs list of strings, list of C static library dependencies

stem string, sets name of the output

suffix string, append to name of output

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

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.