Skip to content
Snippets Groups Projects
Commit 84a0e71a authored by Anton Hansson's avatar Anton Hansson
Browse files

Migrate droidstubs/droiddoc to flags 

The args attribute does not work well with defaults as it's just a
string, which cannot be extended. Migrate to the flags attribute.

Bug: 306806877
Test: diff ninja file before/after
Change-Id: Ifd1d503d2da29bf1cdf2664201f9c8276f9480a4
parent 440f3cf2
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Android.bp
+ 23
− 24
View file @ 84a0e71a
......@@ -560,30 +560,6 @@ java_library {
],
}
// TODO(b/145644363): move this to under StubLibraries.bp or ApiDocs.bp
metalava_framework_docs_args = "" +
"--api-lint-ignore-prefix android.icu. " +
"--api-lint-ignore-prefix java. " +
"--api-lint-ignore-prefix junit. " +
"--api-lint-ignore-prefix org. " +
"--error NoSettingsProvider " +
"--error UnhiddenSystemApi " +
"--error UnflaggedApi " +
"--force-convert-to-warning-nullability-annotations +*:-android.*:+android.icu.*:-dalvik.* " +
"--hide BroadcastBehavior " +
"--hide CallbackInterface " +
"--hide DeprecationMismatch " +
"--hide HiddenSuperclass " +
"--hide HiddenTypeParameter " +
"--hide MissingPermission " +
"--hide-package android.audio.policy.configuration.V7_0 " +
"--hide-package com.android.server " +
"--hide RequiresPermission " +
"--hide SdkConstant " +
"--hide Todo " +
"--hide UnavailableSymbol " +
"--manifest $(location :frameworks-base-core-AndroidManifest.xml) "
packages_to_document = [
"android",
"dalvik",
......@@ -654,6 +630,29 @@ stubs_defaults {
"android.hardware.vibrator-V1.3-java",
"framework-protos",
],
flags: [
"--api-lint-ignore-prefix android.icu.",
"--api-lint-ignore-prefix java.",
"--api-lint-ignore-prefix junit.",
"--api-lint-ignore-prefix org.",
"--error NoSettingsProvider",
"--error UnhiddenSystemApi",
"--error UnflaggedApi",
"--force-convert-to-warning-nullability-annotations +*:-android.*:+android.icu.*:-dalvik.*",
"--hide BroadcastBehavior",
"--hide CallbackInterface",
"--hide DeprecationMismatch",
"--hide HiddenSuperclass",
"--hide HiddenTypeParameter",
"--hide MissingPermission",
"--hide RequiresPermission",
"--hide SdkConstant",
"--hide Todo",
"--hide UnavailableSymbol",
"--hide-package android.audio.policy.configuration.V7_0",
"--hide-package com.android.server",
"--manifest $(location :frameworks-base-core-AndroidManifest.xml)",
],
filter_packages: packages_to_document,
high_mem: true, // Lots of sources => high memory use, see b/170701554
installable: false,
......
api/ApiDocs.bp
+ 87
− 67
View file @ 84a0e71a
......@@ -72,7 +72,6 @@ droidstubs {
"android-non-updatable-doc-stubs-defaults",
"module-classpath-stubs-defaults",
],
args: metalava_framework_docs_args,
}
droidstubs {
......@@ -81,8 +80,7 @@ droidstubs {
"android-non-updatable-doc-stubs-defaults",
"module-classpath-stubs-defaults",
],
args: metalava_framework_docs_args +
" --show-annotation android.annotation.SystemApi\\(client=android.annotation.SystemApi.Client.PRIVILEGED_APPS\\) ",
flags: ["--show-annotation android.annotation.SystemApi\\(client=android.annotation.SystemApi.Client.PRIVILEGED_APPS\\)"],
}
droidstubs {
......@@ -91,9 +89,10 @@ droidstubs {
"android-non-updatable-doc-stubs-defaults",
"module-classpath-stubs-defaults",
],
args: metalava_framework_docs_args +
" --show-annotation android.annotation.SystemApi\\(client=android.annotation.SystemApi.Client.PRIVILEGED_APPS\\) " +
" --show-annotation android.annotation.SystemApi\\(client=android.annotation.SystemApi.Client.MODULE_LIBRARIES\\) ",
flags: [
"--show-annotation android.annotation.SystemApi\\(client=android.annotation.SystemApi.Client.PRIVILEGED_APPS\\)",
"--show-annotation android.annotation.SystemApi\\(client=android.annotation.SystemApi.Client.MODULE_LIBRARIES\\)",
],
generate_stubs: false, // We're only using this module for the annotations.zip output, disable doc-stubs.
write_sdk_values: false,
}
......@@ -104,10 +103,11 @@ droidstubs {
"android-non-updatable-doc-stubs-defaults",
"module-classpath-stubs-defaults",
],
args: metalava_framework_docs_args +
" --show-annotation android.annotation.SystemApi\\(client=android.annotation.SystemApi.Client.PRIVILEGED_APPS\\) " +
" --show-annotation android.annotation.SystemApi\\(client=android.annotation.SystemApi.Client.MODULE_LIBRARIES\\) " +
" --show-annotation android.annotation.SystemApi\\(client=android.annotation.SystemApi.Client.SYSTEM_SERVER\\) ",
flags: [
"--show-annotation android.annotation.SystemApi\\(client=android.annotation.SystemApi.Client.PRIVILEGED_APPS\\)",
"--show-annotation android.annotation.SystemApi\\(client=android.annotation.SystemApi.Client.MODULE_LIBRARIES\\)",
"--show-annotation android.annotation.SystemApi\\(client=android.annotation.SystemApi.Client.SYSTEM_SERVER\\)",
],
generate_stubs: false, // We're only using this module for the annotations.zip output, disable doc-stubs.
write_sdk_values: false,
}
......@@ -116,7 +116,6 @@ droidstubs {
name: "framework-doc-stubs",
defaults: ["android-non-updatable-doc-stubs-defaults"],
srcs: [":all-modules-public-stubs-source"],
args: metalava_framework_docs_args,
api_levels_module: "api_versions_public",
aidl: {
include_dirs: [
......@@ -129,8 +128,7 @@ droidstubs {
droidstubs {
name: "framework-doc-system-stubs",
defaults: ["framework-doc-stubs-sources-default"],
args: metalava_framework_docs_args +
" --show-annotation android.annotation.SystemApi\\(client=android.annotation.SystemApi.Client.PRIVILEGED_APPS\\) ",
flags: ["--show-annotation android.annotation.SystemApi\\(client=android.annotation.SystemApi.Client.PRIVILEGED_APPS\\)"],
api_levels_module: "api_versions_system",
}
......@@ -139,30 +137,6 @@ droidstubs {
// using droiddoc
/////////////////////////////////////////////////////////////////////
// doclava contains checks for a few issues that are have been migrated to metalava.
// disable them in doclava, to avoid mistriggering or double triggering.
ignore_doclava_errors_checked_by_metalava = "" +
"-hide 111 " + // HIDDEN_SUPERCLASS
"-hide 113 " + // DEPRECATION_MISMATCH
"-hide 125 " + // REQUIRES_PERMISSION
"-hide 126 " + // BROADCAST_BEHAVIOR
"-hide 127 " + // SDK_CONSTANT
"-hide 128 " // TODO
framework_docs_only_args = "-android " +
"-manifest $(location :frameworks-base-core-AndroidManifest.xml) " +
"-metalavaApiSince " +
"-werror " +
"-lerror " +
ignore_doclava_errors_checked_by_metalava +
"-overview $(location :frameworks-base-java-overview) " +
// Federate Support Library references against local API file.
"-federate SupportLib https://developer.android.com " +
"-federationapi SupportLib $(location :current-support-api) " +
// Federate Support Library references against local API file.
"-federate AndroidX https://developer.android.com " +
"-federationapi AndroidX $(location :current-androidx-api) "
doc_defaults {
name: "framework-docs-default",
sdk_version: "none",
......@@ -182,6 +156,28 @@ doc_defaults {
resourcesdir: "docs/html/reference/images/",
resourcesoutdir: "reference/android/images/",
lint_baseline: "javadoc-lint-baseline",
flags: [
"-android",
"-manifest $(location :frameworks-base-core-AndroidManifest.xml)",
"-metalavaApiSince",
"-werror",
"-lerror",
"-overview $(location :frameworks-base-java-overview)",
// Federate Support Library references against local API file.
"-federate SupportLib https://developer.android.com",
"-federationapi SupportLib $(location :current-support-api)",
// Federate Support Library references against local API file.
"-federate AndroidX https://developer.android.com",
"-federationapi AndroidX $(location :current-androidx-api)",
// doclava contains checks for a few issues that are have been migrated to metalava.
// disable them in doclava, to avoid mistriggering or double triggering.
"-hide 111", // HIDDEN_SUPERCLASS
"-hide 113", // DEPRECATION_MISMATCH
"-hide 125", // REQUIRES_PERMISSION
"-hide 126", // BROADCAST_BEHAVIOR
"-hide 127", // SDK_CONSTANT
"-hide 128", // TODO
],
hdf: [
"dac true",
"sdk.codename O",
......@@ -217,7 +213,10 @@ droiddoc {
],
compat_config: ":global-compat-config",
proofread_file: "offline-sdk-docs-proofread.txt",
args: framework_docs_only_args + " -offlinemode -title \"Android SDK\"",
flags: [
"-offlinemode",
"-title \"Android SDK\"",
],
static_doc_index_redirect: "docs/docs-preview-index.html",
}
......@@ -234,7 +233,11 @@ droiddoc {
"android.whichdoc offline",
],
proofread_file: "offline-sdk-referenceonly-docs-proofread.txt",
args: framework_docs_only_args + " -offlinemode -title \"Android SDK\" -referenceonly",
flags: [
"-offlinemode",
"-title \"Android SDK\"",
"-referenceonly",
],
static_doc_index_redirect: "docs/docs-documentation-redirect.html",
static_doc_properties: "docs/source.properties",
}
......@@ -252,8 +255,14 @@ droiddoc {
"android.whichdoc offline",
],
proofread_file: "offline-system-sdk-referenceonly-docs-proofread.txt",
args: framework_docs_only_args + " -hide 101 -hide 104 -hide 108" +
" -offlinemode -title \"Android System SDK\" -referenceonly",
flags: [
"-hide 101",
"-hide 104",
"-hide 108",
"-offlinemode",
"-title \"Android System SDK\"",
"-referenceonly",
],
static_doc_index_redirect: "docs/docs-documentation-redirect.html",
static_doc_properties: "docs/source.properties",
}
......@@ -269,22 +278,28 @@ droiddoc {
"android.hasSamples true",
],
proofread_file: "ds-docs-proofread.txt",
args: framework_docs_only_args +
" -toroot / -yamlV2 -samplegroup Admin " +
" -samplegroup Background " +
" -samplegroup Connectivity " +
" -samplegroup Content " +
" -samplegroup Input " +
" -samplegroup Media " +
" -samplegroup Notification " +
" -samplegroup RenderScript " +
" -samplegroup Security " +
" -samplegroup Sensors " +
" -samplegroup System " +
" -samplegroup Testing " +
" -samplegroup UI " +
" -samplegroup Views " +
" -samplegroup Wearable -devsite -samplesdir development/samples/browseable ",
flags: [
" -toroot /",
"-yamlV2",
"-samplegroup Admin",
"-samplegroup Background",
"-samplegroup Connectivity",
"-samplegroup Content",
"-samplegroup Input",
"-samplegroup Media",
"-samplegroup Notification",
"-samplegroup RenderScript",
"-samplegroup Security",
"-samplegroup Sensors",
"-samplegroup System",
"-samplegroup Testing",
"-samplegroup UI",
"-samplegroup Views",
"-samplegroup Wearable",
"-devsite",
"-samplesdir",
"development/samples/browseable",
],
}
droiddoc {
......@@ -292,8 +307,11 @@ droiddoc {
srcs: [
":framework-doc-stubs",
],
args: "-noJdkLink -links https://kotlinlang.org/api/latest/jvm/stdlib/^external/dokka/package-list " +
flags: [
"-noJdkLink",
"-links https://kotlinlang.org/api/latest/jvm/stdlib/^external/dokka/package-list",
"-noStdlibLink",
],
proofread_file: "ds-dokka-proofread.txt",
dokka_enabled: true,
}
......@@ -346,11 +364,12 @@ droiddoc {
hdf: [
"android.whichdoc online",
],
args: framework_docs_only_args +
" -staticonly " +
" -toroot / " +
" -devsite " +
" -ignoreJdLinks ",
flags: [
"-staticonly",
"-toroot /",
"-devsite",
"-ignoreJdLinks",
],
}
droiddoc {
......@@ -362,8 +381,9 @@ droiddoc {
hdf: [
"android.whichdoc online",
],
args: framework_docs_only_args +
" -toroot / " +
" -atLinksNavtree " +
" -navtreeonly ",
flags: [
"-toroot /",
"-atLinksNavtree",
"-navtreeonly",
],
}
api/StubLibraries.bp
+ 20
− 15
View file @ 84a0e71a
......@@ -36,7 +36,6 @@ droidstubs {
"android-non-updatable-stubs-defaults",
"module-classpath-stubs-defaults",
],
args: metalava_framework_docs_args,
check_api: {
current: {
api_file: ":non-updatable-current.txt",
......@@ -70,19 +69,25 @@ droidstubs {
api_surface: "public",
}
priv_apps = " --show-annotation android.annotation.SystemApi\\(" +
"client=android.annotation.SystemApi.Client.PRIVILEGED_APPS" +
"\\)"
priv_apps = [
"--show-annotation android.annotation.SystemApi\\(" +
"client=android.annotation.SystemApi.Client.PRIVILEGED_APPS" +
"\\)",
]
priv_apps_in_stubs = " --show-for-stub-purposes-annotation android.annotation.SystemApi\\(" +
"client=android.annotation.SystemApi.Client.PRIVILEGED_APPS" +
"\\)"
priv_apps_in_stubs = [
"--show-for-stub-purposes-annotation android.annotation.SystemApi\\(" +
"client=android.annotation.SystemApi.Client.PRIVILEGED_APPS" +
"\\)",
]
test = " --show-annotation android.annotation.TestApi"
test = ["--show-annotation android.annotation.TestApi"]
module_libs = " --show-annotation android.annotation.SystemApi\\(" +
"client=android.annotation.SystemApi.Client.MODULE_LIBRARIES" +
"\\)"
module_libs = [
"--show-annotation android.annotation.SystemApi\\(" +
"client=android.annotation.SystemApi.Client.MODULE_LIBRARIES" +
"\\)",
]
droidstubs {
name: "system-api-stubs-docs-non-updatable",
......@@ -93,7 +98,7 @@ droidstubs {
"android-non-updatable-stubs-defaults",
"module-classpath-stubs-defaults",
],
args: metalava_framework_docs_args + priv_apps,
flags: priv_apps,
check_api: {
current: {
api_file: ":non-updatable-system-current.txt",
......@@ -136,7 +141,7 @@ droidstubs {
"android-non-updatable-stubs-defaults",
"module-classpath-stubs-defaults",
],
args: metalava_framework_docs_args + test + priv_apps_in_stubs,
flags: test + priv_apps_in_stubs,
check_api: {
current: {
api_file: ":non-updatable-test-current.txt",
......@@ -186,7 +191,7 @@ droidstubs {
"android-non-updatable-stubs-defaults",
"module-classpath-stubs-defaults",
],
args: metalava_framework_docs_args + priv_apps_in_stubs + module_libs,
flags: priv_apps_in_stubs + module_libs,
check_api: {
current: {
api_file: ":non-updatable-module-lib-current.txt",
......@@ -956,7 +961,7 @@ droidstubs {
merge_annotations_dirs: [
"metalava-manual",
],
args: priv_apps,
flags: priv_apps,
}
java_library {
......
services/Android.bp
+ 7
− 5
View file @ 84a0e71a
......@@ -235,12 +235,14 @@ filegroup {
stubs_defaults {
name: "services-stubs-default",
installable: false,
args: " --show-annotation android.annotation.SystemApi\\(client=android.annotation.SystemApi.Client.SYSTEM_SERVER\\)" +
" --hide-annotation android.annotation.Hide" +
" --hide InternalClasses" + // com.android.* classes are okay in this interface
flags: [
"--show-annotation android.annotation.SystemApi\\(client=android.annotation.SystemApi.Client.SYSTEM_SERVER\\)",
"--hide-annotation android.annotation.Hide",
"--hide InternalClasses", // com.android.* classes are okay in this interface
// TODO: remove the --hide options below
" --hide DeprecationMismatch" +
" --hide HiddenTypedefConstant",
"--hide DeprecationMismatch",
"--hide HiddenTypedefConstant",
],
visibility: ["//frameworks/base:__subpackages__"],
filter_packages: ["com.android."],
}
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment