From 9e14b96f294545d04d0f2188086b53973244b06f Mon Sep 17 00:00:00 2001 From: Patrice Arruda Date: Mon, 11 Mar 2019 15:58:50 -0700 Subject: [PATCH] Soong: Update documentation on prebuilt* modules. The prebuilt_etc_host is missing synopsis. Also, cleaned up the synopsis of the remaining prebuilt* module to be clearer. Bug: b/128337482 Test: Built the documentation and verified that the output is correct. Change-Id: I64593970a44b548ac841de79aa0e4aa1699c6c9b --- android/prebuilt_etc.go | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/android/prebuilt_etc.go b/android/prebuilt_etc.go index 6c8fb314d..0c68b0cce 100644 --- a/android/prebuilt_etc.go +++ b/android/prebuilt_etc.go @@ -174,7 +174,8 @@ func InitPrebuiltEtcModule(p *PrebuiltEtc) { p.AddProperties(&p.properties) } -// prebuilt_etc is for prebuilts that will be installed to /etc/ +// prebuilt_etc is for a prebuilt artifact that is installed in +// /etc/ directory. func PrebuiltEtcFactory() Module { module := &PrebuiltEtc{installDirBase: "etc"} InitPrebuiltEtcModule(module) @@ -183,6 +184,8 @@ func PrebuiltEtcFactory() Module { return module } +// prebuilt_etc_host is for a host prebuilt artifact that is installed in +// $(HOST_OUT)/etc/ directory. func PrebuiltEtcHostFactory() Module { module := &PrebuiltEtc{installDirBase: "etc"} InitPrebuiltEtcModule(module) @@ -191,7 +194,8 @@ func PrebuiltEtcHostFactory() Module { return module } -// prebuilt_usr_share is for prebuilts that will be installed to /usr/share/ +// prebuilt_usr_share is for a prebuilt artifact that is installed in +// /usr/share/ directory. func PrebuiltUserShareFactory() Module { module := &PrebuiltEtc{installDirBase: "usr/share"} InitPrebuiltEtcModule(module) @@ -200,7 +204,8 @@ func PrebuiltUserShareFactory() Module { return module } -// prebuild_usr_share_host is for host prebuilts that will be installed to /usr/share/ +// prebuild_usr_share_host is for a host prebuilt artifact that is installed in +// $(HOST_OUT)/usr/share/ directory. func PrebuiltUserShareHostFactory() Module { module := &PrebuiltEtc{installDirBase: "usr/share"} InitPrebuiltEtcModule(module)