| // Copyright 2019 The Bazel Authors. 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 com.google.devtools.build.lib.packages; |
| |
| import com.google.common.collect.Interner; |
| import com.google.devtools.build.lib.concurrent.BlazeInterners; |
| import com.google.devtools.build.lib.syntax.StarlarkSemantics; |
| import com.google.devtools.common.options.Converters.CommaSeparatedOptionListConverter; |
| import com.google.devtools.common.options.Option; |
| import com.google.devtools.common.options.OptionDocumentationCategory; |
| import com.google.devtools.common.options.OptionEffectTag; |
| import com.google.devtools.common.options.OptionMetadataTag; |
| import com.google.devtools.common.options.OptionsBase; |
| import java.io.Serializable; |
| import java.util.List; |
| |
| /** |
| * Contains options that affect Starlark's semantics. |
| * |
| * <p>These are injected into Skyframe (as an instance of {@link StarlarkSemantics}) when a new |
| * build invocation occurs. Changing these options between builds will therefore trigger a |
| * reevaluation of everything that depends on the Starlark interpreter — in particular, |
| * evaluation of all BUILD and .bzl files. |
| * |
| * <p><em>To add a new option, update the following:</em> |
| * |
| * <ul> |
| * <li>Add a new abstract method (which is interpreted by {@code AutoValue} as a field) to {@link |
| * StarlarkSemantics} and {@link StarlarkSemantics.Builder}. Set its default value in {@link |
| * StarlarkSemantics#DEFAULT_SEMANTICS}. |
| * <li>Add a new {@code @Option}-annotated field to this class. The field name and default value |
| * should be the same as in {@link StarlarkSemantics}, and the option name in the annotation |
| * should be that name written in snake_case. Add a line to set the new field in {@link |
| * #toSkylarkSemantics}. |
| * <li>Add a line to set the new field in both {@link |
| * SkylarkSemanticsConsistencyTest#buildRandomOptions} and {@link |
| * SkylarkSemanticsConsistencyTest#buildRandomSemantics}. |
| * <li>Update manual documentation in site/docs/skylark/backward-compatibility.md. Also remember |
| * to update this when flipping a flag's default value. |
| * <li>Boolean semantic flags can toggle Skylark methods on or off. To do this, add a new entry to |
| * {@link StarlarkSemantics#FlagIdentifier}. Then, specify the identifier in {@code |
| * SkylarkCallable.enableOnlyWithFlag} or {@code SkylarkCallable.disableWithFlag}. |
| * </ul> |
| * |
| * For both readability and correctness, the relative order of the options in all of these locations |
| * must be kept consistent; to make it easy we use alphabetic order. The parts that need updating |
| * are marked with the comment "<== Add new options here in alphabetic order ==>". |
| */ |
| public class StarlarkSemanticsOptions extends OptionsBase implements Serializable { |
| |
| // <== Add new options here in alphabetic order ==> |
| |
| @Option( |
| name = "experimental_action_args", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BAZEL_INTERNAL_CONFIGURATION}, |
| metadataTags = {OptionMetadataTag.EXPERIMENTAL}, |
| help = |
| "If set to true, Action objects support an `args` field: " |
| + "a frozen Args object which contains all action arguments.") |
| public boolean experimentalActionArgs; |
| |
| @Option( |
| name = "experimental_allow_incremental_repository_updates", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BAZEL_INTERNAL_CONFIGURATION}, |
| metadataTags = {OptionMetadataTag.EXPERIMENTAL}, |
| help = |
| "This flag will be removed in Bazel 1.0. Please do not use it.\n" |
| + "Incremental repository updates feature is now enabled without the flag.") |
| public boolean experimentalAllowIncrementalRepositoryUpdates; |
| |
| @Option( |
| name = "experimental_aspect_output_propagation", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS}, |
| metadataTags = {OptionMetadataTag.EXPERIMENTAL}, |
| help = |
| "If set to true, allows Starlark aspects to be defined with `apply_to_generating_rules`, " |
| + "which will enable them to propagate through output file target nodes.") |
| public boolean experimentalAspectOutputPropagation; |
| |
| @Option( |
| name = "experimental_build_setting_api", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, |
| effectTags = OptionEffectTag.BUILD_FILE_SEMANTICS, |
| help = |
| "If set to true, allows access to value of build setting rules via " |
| + "ctx.build_setting_value.") |
| public boolean experimentalBuildSettingApi; |
| |
| @Option( |
| name = "experimental_cc_skylark_api_enabled_packages", |
| converter = CommaSeparatedOptionListConverter.class, |
| defaultValue = "", |
| documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS}, |
| metadataTags = {OptionMetadataTag.EXPERIMENTAL}, |
| help = |
| "Passes list of packages that can use the C++ Starlark API. Don't enable this flag yet, " |
| + "we will be making breaking changes.") |
| public List<String> experimentalCcSkylarkApiEnabledPackages; |
| |
| @Option( |
| name = "experimental_enable_android_migration_apis", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = OptionEffectTag.BUILD_FILE_SEMANTICS, |
| help = "If set to true, enables the APIs required to support the Android Starlark migration.") |
| public boolean experimentalEnableAndroidMigrationApis; |
| |
| @Option( |
| name = "experimental_google_legacy_api", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS}, |
| metadataTags = {OptionMetadataTag.EXPERIMENTAL}, |
| help = |
| "If set to true, exposes a number of experimental pieces of Starlark build API " |
| + "pertaining to Google legacy code.") |
| public boolean experimentalGoogleLegacyApi; |
| |
| @Option( |
| name = "experimental_platforms_api", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS}, |
| metadataTags = {OptionMetadataTag.EXPERIMENTAL}, |
| help = |
| "If set to true, enables a number of platform-related Starlark APIs useful for " |
| + "debugging.") |
| public boolean experimentalPlatformsApi; |
| |
| @Option( |
| name = "experimental_starlark_config_transitions", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS}, |
| metadataTags = {OptionMetadataTag.EXPERIMENTAL}, |
| help = |
| "If set to true, enables creation of configuration transition objects (the " |
| + "`transition()` function) in Starlark.") |
| public boolean experimentalStarlarkConfigTransitions; |
| |
| @Option( |
| name = "experimental_starlark_unused_inputs_list", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.CHANGES_INPUTS}, |
| metadataTags = {OptionMetadataTag.EXPERIMENTAL}, |
| help = "If set to true, enables use of 'unused_inputs_list' in starlark action.run().") |
| public boolean experimentalStarlarkUnusedInputsList; |
| |
| @Option( |
| name = "incompatible_bzl_disallow_load_after_statement", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = |
| "If set to true, all `load` must be called at the top of .bzl files, before any other " |
| + "statement.") |
| public boolean incompatibleBzlDisallowLoadAfterStatement; |
| |
| @Option( |
| name = "experimental_allow_tags_propagation", |
| oldName = "incompatible_allow_tags_propagation", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, |
| metadataTags = { |
| OptionMetadataTag.EXPERIMENTAL, |
| }, |
| help = |
| "If set to true, tags will be propagated from a target to the actions' execution" |
| + " requirements; otherwise tags are not propagated. See" |
| + " https://github.com/bazelbuild/bazel/issues/8830 for details.") |
| public boolean experimentalAllowTagsPropagation; |
| |
| @Option( |
| name = "incompatible_depset_union", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = |
| "If set to true, depset union using `+`, `|` or `.union` are forbidden. " |
| + "Use the `depset` constructor instead.") |
| public boolean incompatibleDepsetUnion; |
| |
| @Option( |
| name = "incompatible_depset_is_not_iterable", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = |
| "If set to true, depset type is not iterable. For loops and functions expecting an " |
| + "iterable will reject depset objects. Use the `.to_list` method to explicitly " |
| + "convert to a list.") |
| public boolean incompatibleDepsetIsNotIterable; |
| |
| @Option( |
| name = "incompatible_disable_target_provider_fields", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = |
| "If set to true, disable the ability to access providers on 'target' objects via field " |
| + "syntax. Use provider-key syntax instead. For example, instead of using " |
| + "`ctx.attr.dep.my_info` to access `my_info` from inside a rule implementation " |
| + "function, use `ctx.attr.dep[MyInfo]`. See " |
| + "https://github.com/bazelbuild/bazel/issues/9014 for details.") |
| public boolean incompatibleDisableTargetProviderFields; |
| |
| @Option( |
| name = "incompatible_disable_deprecated_attr_params", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = |
| "If set to true, disable the deprecated parameters 'single_file' and 'non_empty' on " |
| + "attribute definition methods, such as attr.label().") |
| public boolean incompatibleDisableDeprecatedAttrParams; |
| |
| @Option( |
| name = "incompatible_disable_depset_items", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = |
| "If set to true, disable the 'items' parameter of the depset constructor. Use " |
| + "the 'transitive' and 'direct' parameters instead.") |
| public boolean incompatibleDisableDepsetItems; |
| |
| // For Bazel, this flag is a no-op. Bazel doesn't support built-in third party license checking |
| // (see https://github.com/bazelbuild/bazel/issues/7444). |
| // |
| // For Blaze in Google, this flag is still needed to deprecate the logic that's already been |
| // removed from Bazel. That logic was introduced before Bazel existed, so Google's dependency on |
| // it is deeper. But we don't want that to add unnecessary baggage to Bazel or slow down Bazel's |
| // development. So this flag lets Blaze migrate on a slower timeline without blocking Bazel. This |
| // means you as a Bazel user are getting better code than Google has! (for a while, at least) |
| @Option( |
| name = "incompatible_disable_third_party_license_checking", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = OptionEffectTag.BUILD_FILE_SEMANTICS, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = "If true, disables all license checking logic") |
| public boolean incompatibleDisableThirdPartyLicenseChecking; |
| |
| @Option( |
| name = "incompatible_disallow_dict_lookup_unhashable_keys", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = |
| "If set to true, dict key lookups using `in` or `dict.get` will fail with unhashable" |
| + " types.") |
| public boolean incompatibleDisallowDictLookupUnhashableKeys; |
| |
| @Option( |
| name = "incompatible_disallow_dict_plus", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = "If set to true, the `+` becomes disabled for dicts.") |
| public boolean incompatibleDisallowDictPlus; |
| |
| @Option( |
| name = "incompatible_disallow_empty_glob", |
| defaultValue = "false", |
| category = "incompatible changes", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = "If set to true, the default value of the `allow_empty` argument of glob() is False.") |
| public boolean incompatibleDisallowEmptyGlob; |
| |
| @Option( |
| name = "incompatible_disallow_hashing_frozen_mutables", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = "If set to true, freezing a mutable object will not make it hashable.") |
| public boolean incompatibleDisallowHashingFrozenMutables; |
| |
| @Option( |
| name = "incompatible_disallow_legacy_javainfo", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = "Deprecated. No-op.") |
| // TODO(elenairina): Move option to graveyard after the flag is removed from the global blazerc. |
| public boolean incompatibleDisallowLegacyJavaInfo; |
| |
| @Option( |
| name = "incompatible_disallow_rule_execution_platform_constraints_allowed", |
| defaultValue = "True", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = |
| "If set to true, disallow the use of the execution_platform_constraints_allowed " |
| + "attribute on rule().") |
| public boolean incompatibleDisallowRuleExecutionPlatformConstraintsAllowed; |
| |
| @Option( |
| name = "incompatible_string_join_requires_strings", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = |
| "If set to true, the argument of `string.join` must be an iterable whose elements are " |
| + "strings. If set to false, elements are first converted to string. " |
| + "See https://github.com/bazelbuild/bazel/issues/7802") |
| public boolean incompatibleStringJoinRequiresStrings; |
| |
| @Option( |
| name = "incompatible_disallow_struct_provider_syntax", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = |
| "If set to true, rule implementation functions may not return a struct. They must " |
| + "instead return a list of provider instances.") |
| public boolean incompatibleDisallowStructProviderSyntax; |
| |
| /** Controls legacy arguments to ctx.actions.Args#add. */ |
| @Option( |
| name = "incompatible_disallow_old_style_args_add", |
| defaultValue = "true", |
| category = "incompatible changes", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = "If set to true, vectorized calls to Args#add are disallowed.") |
| public boolean incompatibleDisallowOldStyleArgsAdd; |
| |
| @Option( |
| name = "incompatible_disallow_unverified_http_downloads", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = "If set, disallow downloads via plain http if no checksum is given") |
| public boolean incompatibleDisallowUnverifiedHttpDownloads; |
| |
| @Option( |
| name = "incompatible_expand_directories", |
| defaultValue = "true", |
| category = "incompatible changes", |
| documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, |
| effectTags = {OptionEffectTag.UNKNOWN}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = |
| "Controls whether directories are expanded to the list of files under that directory " |
| + "when added to Args, instead of replaced by the path of the directory.") |
| public boolean incompatibleExpandDirectories; |
| |
| @Option( |
| name = "incompatible_new_actions_api", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = |
| "If set to true, the API to create actions is only available on `ctx.actions`, " |
| + "not on `ctx`.") |
| public boolean incompatibleNewActionsApi; |
| |
| @Option( |
| name = "incompatible_no_attr_license", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = "If set to true, disables the function `attr.license`.") |
| public boolean incompatibleNoAttrLicense; |
| |
| @Option( |
| name = "incompatible_no_output_attr_default", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = |
| "If set to true, disables the `default` parameter of the `attr.output` and " |
| + "`attr.output_list` attribute definition functions.") |
| public boolean incompatibleNoOutputAttrDefault; |
| |
| @Option( |
| name = "incompatible_no_rule_outputs_param", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = "If set to true, disables the `outputs` parameter of the `rule()` Starlark function.") |
| public boolean incompatibleNoRuleOutputsParam; |
| |
| @Option( |
| name = "incompatible_no_support_tools_in_action_inputs", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = |
| "If set to true, tools should be passed to `ctx.actions.run()` and " |
| + "`ctx.actions.run_shell()` using the `tools` parameter instead of the `inputs` " |
| + "parameter. Furthermore, if this flag is set and a `tools` parameter is not " |
| + "passed to the action, it is an error for any tools to appear in the `inputs`.") |
| public boolean incompatibleNoSupportToolsInActionInputs; |
| |
| @Option( |
| name = "incompatible_no_target_output_group", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = "If set to true, disables the output_group field of the 'Target' Starlark type.") |
| public boolean incompatibleNoTargetOutputGroup; |
| |
| @Option( |
| name = "incompatible_no_transitive_loads", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = |
| "If set to true, only symbols explicitly defined in the file can be loaded; " |
| + "symbols introduced by load are not implicitly re-exported.") |
| public boolean incompatibleNoTransitiveLoads; |
| |
| @Option( |
| name = "incompatible_remap_main_repo", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = OptionEffectTag.LOADING_AND_ANALYSIS, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| oldName = "experimental_remap_main_repo", |
| help = "If set to true, will treat references to '@<main repo name>' the same as '@'.") |
| public boolean incompatibleRemapMainRepo; |
| |
| @Option( |
| name = "incompatible_remove_native_maven_jar", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = |
| "If set to true, the native maven_jar rule is disabled; only the Starlark version " |
| + "will be available") |
| public boolean incompatibleRemoveNativeMavenJar; |
| |
| @Option( |
| name = "incompatible_run_shell_command_string", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = "If set to true, the command parameter of actions.run_shell will only accept string") |
| public boolean incompatibleRunShellCommandString; |
| |
| /** Used in an integration test to confirm that flags are visible to the interpreter. */ |
| @Option( |
| name = "internal_skylark_flag_test_canary", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, |
| effectTags = {OptionEffectTag.UNKNOWN}) |
| public boolean internalSkylarkFlagTestCanary; |
| |
| @Option( |
| name = "incompatible_do_not_split_linking_cmdline", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.BUILD_TIME_OPTIMIZATION, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = |
| "When true, Bazel no longer modifies command line flags used for linking, and also " |
| + "doesn't selectively decide which flags go to the param file and which don't. " |
| + "See https://github.com/bazelbuild/bazel/issues/7670 for details.") |
| public boolean incompatibleDoNotSplitLinkingCmdline; |
| |
| @Option( |
| name = "incompatible_restrict_named_params", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = |
| "If set to true, restricts a number of Starlark built-in function parameters to be " |
| + "only specifiable positionally (and not by keyword).") |
| public boolean incompatibleRestrictNamedParams; |
| |
| @Option( |
| name = "incompatible_depset_for_libraries_to_link_getter", |
| defaultValue = "true", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.LOADING_AND_ANALYSIS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = |
| "When true, Bazel no longer returns a list from linking_context.libraries_to_link but " |
| + "returns a depset instead.") |
| public boolean incompatibleDepsetForLibrariesToLinkGetter; |
| |
| @Option( |
| name = "incompatible_restrict_string_escapes", |
| defaultValue = "false", |
| documentationCategory = OptionDocumentationCategory.STARLARK_SEMANTICS, |
| effectTags = {OptionEffectTag.BUILD_FILE_SEMANTICS}, |
| metadataTags = { |
| OptionMetadataTag.INCOMPATIBLE_CHANGE, |
| OptionMetadataTag.TRIGGERED_BY_ALL_INCOMPATIBLE_CHANGES |
| }, |
| help = "If set to true, unknown string escapes like `\\a` become rejected.") |
| public boolean incompatibleRestrictStringEscapes; |
| |
| /** |
| * An interner to reduce the number of StarlarkSemantics instances. A single Blaze instance should |
| * never accumulate a large number of these and being able to shortcut on object identity makes a |
| * comparison later much faster. In particular, the semantics become part of the |
| * MethodDescriptorKey in FuncallExpression and are thus compared for every function call. |
| */ |
| private static final Interner<StarlarkSemantics> INTERNER = BlazeInterners.newWeakInterner(); |
| |
| /** Constructs a {@link StarlarkSemantics} object corresponding to this set of option values. */ |
| public StarlarkSemantics toSkylarkSemantics() { |
| StarlarkSemantics semantics = |
| StarlarkSemantics.builder() |
| // <== Add new options here in alphabetic order ==> |
| .experimentalActionArgs(experimentalActionArgs) |
| .experimentalAllowIncrementalRepositoryUpdates( |
| experimentalAllowIncrementalRepositoryUpdates) |
| .experimentalAllowTagsPropagation(experimentalAllowTagsPropagation) |
| .experimentalAspectOutputPropagation(experimentalAspectOutputPropagation) |
| .experimentalBuildSettingApi(experimentalBuildSettingApi) |
| .experimentalCcSkylarkApiEnabledPackages(experimentalCcSkylarkApiEnabledPackages) |
| .experimentalEnableAndroidMigrationApis(experimentalEnableAndroidMigrationApis) |
| .experimentalGoogleLegacyApi(experimentalGoogleLegacyApi) |
| .experimentalPlatformsApi(experimentalPlatformsApi) |
| .experimentalStarlarkConfigTransitions(experimentalStarlarkConfigTransitions) |
| .experimentalStarlarkUnusedInputsList(experimentalStarlarkUnusedInputsList) |
| .incompatibleBzlDisallowLoadAfterStatement(incompatibleBzlDisallowLoadAfterStatement) |
| .incompatibleDepsetIsNotIterable(incompatibleDepsetIsNotIterable) |
| .incompatibleDepsetUnion(incompatibleDepsetUnion) |
| .incompatibleDisableTargetProviderFields(incompatibleDisableTargetProviderFields) |
| .incompatibleDisableThirdPartyLicenseChecking( |
| incompatibleDisableThirdPartyLicenseChecking) |
| .incompatibleDisableDeprecatedAttrParams(incompatibleDisableDeprecatedAttrParams) |
| .incompatibleDisableDepsetItems(incompatibleDisableDepsetItems) |
| .incompatibleDisallowDictPlus(incompatibleDisallowDictPlus) |
| .incompatibleDisallowEmptyGlob(incompatibleDisallowEmptyGlob) |
| .incompatibleDisallowOldStyleArgsAdd(incompatibleDisallowOldStyleArgsAdd) |
| .incompatibleDisallowStructProviderSyntax(incompatibleDisallowStructProviderSyntax) |
| .incompatibleDisallowRuleExecutionPlatformConstraintsAllowed( |
| incompatibleDisallowRuleExecutionPlatformConstraintsAllowed) |
| .incompatibleDisallowUnverifiedHttpDownloads( |
| incompatibleDisallowUnverifiedHttpDownloads) |
| .incompatibleExpandDirectories(incompatibleExpandDirectories) |
| .incompatibleNewActionsApi(incompatibleNewActionsApi) |
| .incompatibleNoAttrLicense(incompatibleNoAttrLicense) |
| .incompatibleNoOutputAttrDefault(incompatibleNoOutputAttrDefault) |
| .incompatibleNoRuleOutputsParam(incompatibleNoRuleOutputsParam) |
| .incompatibleNoSupportToolsInActionInputs(incompatibleNoSupportToolsInActionInputs) |
| .incompatibleNoTargetOutputGroup(incompatibleNoTargetOutputGroup) |
| .incompatibleNoTransitiveLoads(incompatibleNoTransitiveLoads) |
| .incompatibleRemapMainRepo(incompatibleRemapMainRepo) |
| .incompatibleRemoveNativeMavenJar(incompatibleRemoveNativeMavenJar) |
| .incompatibleRestrictNamedParams(incompatibleRestrictNamedParams) |
| .incompatibleRunShellCommandString(incompatibleRunShellCommandString) |
| .incompatibleStringJoinRequiresStrings(incompatibleStringJoinRequiresStrings) |
| .internalSkylarkFlagTestCanary(internalSkylarkFlagTestCanary) |
| .incompatibleDoNotSplitLinkingCmdline(incompatibleDoNotSplitLinkingCmdline) |
| .incompatibleDepsetForLibrariesToLinkGetter(incompatibleDepsetForLibrariesToLinkGetter) |
| .incompatibleRestrictStringEscapes(incompatibleRestrictStringEscapes) |
| .incompatibleDisallowDictLookupUnhashableKeys( |
| incompatibleDisallowDictLookupUnhashableKeys) |
| .incompatibleDisallowHashingFrozenMutables(incompatibleDisallowHashingFrozenMutables) |
| .build(); |
| return INTERNER.intern(semantics); |
| } |
| } |
