Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 54d9bb70 authored by Paul Duffin's avatar Paul Duffin
Browse files

Improve documentation of the enabled property 

Makes it clear that disabling a module is something that should be
avoided if possible.

Test: m soong_docs
Change-Id: Ief11e705f049edfd53b2af66bdf753f24d32aa71
parent 4e29184a

android/module.go

+6 −0
Original line number Diff line number Diff line
@@ -293,6 +293,12 @@ type nameProperties struct { 


type commonProperties struct {

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

	Enabled *bool `android:"arch_variant"`



	// Controls the visibility of this module to other modules. Allowable values are one or more of