7ac943f7e1
Use of `--hide-annotation android.annotation.FlaggedApi` was always an intermediate solution until the required semantics for `@FlaggedApi` was determined. The `--revert-annotation` option provides those semantics. When the `@FlaggedApi` is applied to an existing API, e.g. because it has moved from system to public, or because it has changed in some way, e.g. modifiers, then the correct semantics for when that API is not required is not to hide the API but to revert it to what it was before the change necessitating the `@FlaggedApi` annotation was made. Use --revert-annotation instead of --hide-annotation Use of `--hide-annotation android.annotation.FlaggedApi` was always an intermediate solution until the required semantics for `@FlaggedApi` was determined. The `--revert-annotation` option provides those semantics. When the `@FlaggedApi` is applied to an existing API, e.g. because it has moved from system to public, or because it has changed in some way, e.g. modifiers, then the correct semantics for when that API is not required is not to hide the API but to revert it to what it was before the change necessitating the `@FlaggedApi` annotation was made. Use --revert-annotation instead of --hide-annotation Use of `--hide-annotation android.annotation.FlaggedApi` was always an intermediate solution until the required semantics for `@FlaggedApi` was determined. The `--revert-annotation` option provides those semantics. When the `@FlaggedApi` is applied to an existing API, e.g. because it has moved from system to public, or because it has changed in some way, e.g. modifiers, then the correct semantics for when that API is not required is not to hide the API but to revert it to what it was before the change necessitating the `@FlaggedApi` annotation was made. Bug: 314196587 Test: ./gradlew Change-Id: Ic97f29dd2b9f598ba0851f5f622c2a2724f18037
82 lines
2.5 KiB
Go
82 lines
2.5 KiB
Go
// Copyright 2023 Google Inc. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package config
|
|
|
|
import "strings"
|
|
|
|
var (
|
|
metalavaFlags = []string{
|
|
"--color",
|
|
"--quiet",
|
|
"--format=v2",
|
|
"--repeat-errors-max 10",
|
|
"--hide UnresolvedImport",
|
|
"--hide InvalidNullabilityOverride",
|
|
|
|
// Force metalava to ignore classes on the classpath when an API file contains missing classes.
|
|
// See b/285140653 for more information.
|
|
"--api-class-resolution api",
|
|
|
|
// Force metalava to sort overloaded methods by their order in the source code.
|
|
// See b/285312164 for more information.
|
|
// And add concrete overrides of abstract methods, see b/299366704 for more
|
|
// information.
|
|
"--format-defaults overloaded-method-order=source,add-additional-overrides=yes",
|
|
}
|
|
|
|
MetalavaFlags = strings.Join(metalavaFlags, " ")
|
|
|
|
metalavaAnnotationsFlags = []string{
|
|
"--include-annotations",
|
|
"--exclude-annotation androidx.annotation.RequiresApi",
|
|
}
|
|
|
|
MetalavaAnnotationsFlags = strings.Join(metalavaAnnotationsFlags, " ")
|
|
|
|
metalavaAnnotationsWarningsFlags = []string{
|
|
// TODO(tnorbye): find owners to fix these warnings when annotation was enabled.
|
|
"--hide HiddenTypedefConstant",
|
|
"--hide SuperfluousPrefix",
|
|
"--hide AnnotationExtraction",
|
|
// b/222738070
|
|
"--hide BannedThrow",
|
|
}
|
|
|
|
MetalavaAnnotationsWarningsFlags = strings.Join(metalavaAnnotationsWarningsFlags, " ")
|
|
|
|
metalavaHideFlaggedApis = []string{
|
|
"--revert-annotation",
|
|
"android.annotation.FlaggedApi",
|
|
}
|
|
|
|
MetalavaHideFlaggedApis = strings.Join(metalavaHideFlaggedApis, " ")
|
|
)
|
|
|
|
const (
|
|
MetalavaAddOpens = "-J--add-opens=java.base/java.util=ALL-UNNAMED"
|
|
)
|
|
|
|
func init() {
|
|
exportedVars.ExportStringList("MetalavaFlags", metalavaFlags)
|
|
|
|
exportedVars.ExportString("MetalavaAddOpens", MetalavaAddOpens)
|
|
|
|
exportedVars.ExportStringList("MetalavaHideFlaggedApis", metalavaHideFlaggedApis)
|
|
|
|
exportedVars.ExportStringListStaticVariable("MetalavaAnnotationsFlags", metalavaAnnotationsFlags)
|
|
|
|
exportedVars.ExportStringListStaticVariable("MetalavaAnnotationWarningsFlags", metalavaAnnotationsWarningsFlags)
|
|
}
|