From 59a0e4f10bf037dcd4f257b2e21573fa1b690e93 Mon Sep 17 00:00:00 2001
From: ccalvarin <ccalvarin@google.com>
Date: Fri, 30 Jun 2017 16:01:36 +0200
Subject: Enforce the new category and effect tags.

All options need to explicitly list their category and effect. If they are uncategorized, this makes the lack of information obvious. Remove defaults from the annotation to enforce this.

Also enforce the sanity check that no option should have UNKNOWN or NO_OP effects listed with other effect tags.

Includes some last default sets for options I missed in the previous mass-setting change, and some that were added since.

PiperOrigin-RevId: 160641861
---
 .../com/google/devtools/build/lib/remote/RemoteOptions.java  | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'src/main/java/com/google/devtools/build/lib/remote')

diff --git a/src/main/java/com/google/devtools/build/lib/remote/RemoteOptions.java b/src/main/java/com/google/devtools/build/lib/remote/RemoteOptions.java
index d472adae09..203128dab1 100644
--- a/src/main/java/com/google/devtools/build/lib/remote/RemoteOptions.java
+++ b/src/main/java/com/google/devtools/build/lib/remote/RemoteOptions.java
@@ -159,6 +159,8 @@ public final class RemoteOptions extends OptionsBase {
     name = "experimental_remote_retry",
     defaultValue = "true",
     category = "remote",
+    documentationCategory = OptionDocumentationCategory.UNCATEGORIZED,
+    effectTags = {OptionEffectTag.UNKNOWN},
     help = "Whether to retry transient remote execution/cache errors."
   )
   public boolean experimentalRemoteRetry;
@@ -167,6 +169,8 @@ public final class RemoteOptions extends OptionsBase {
     name = "experimental_remote_retry_start_delay_millis",
     defaultValue = "100",
     category = "remote",
+    documentationCategory = OptionDocumentationCategory.UNCATEGORIZED,
+    effectTags = {OptionEffectTag.UNKNOWN},
     help = "The initial delay before retrying a transient error."
   )
   public long experimentalRemoteRetryStartDelayMillis;
@@ -175,6 +179,8 @@ public final class RemoteOptions extends OptionsBase {
     name = "experimental_remote_retry_max_delay_millis",
     defaultValue = "5000",
     category = "remote",
+    documentationCategory = OptionDocumentationCategory.UNCATEGORIZED,
+    effectTags = {OptionEffectTag.UNKNOWN},
     help = "The maximum delay before retrying a transient error."
   )
   public long experimentalRemoteRetryMaxDelayMillis;
@@ -183,6 +189,8 @@ public final class RemoteOptions extends OptionsBase {
     name = "experimental_remote_retry_max_attempts",
     defaultValue = "5",
     category = "remote",
+    documentationCategory = OptionDocumentationCategory.UNCATEGORIZED,
+    effectTags = {OptionEffectTag.UNKNOWN},
     help = "The maximum number of attempts to retry a transient error."
   )
   public int experimentalRemoteRetryMaxAttempts;
@@ -191,6 +199,8 @@ public final class RemoteOptions extends OptionsBase {
     name = "experimental_remote_retry_multiplier",
     defaultValue = "2",
     category = "remote",
+    documentationCategory = OptionDocumentationCategory.UNCATEGORIZED,
+    effectTags = {OptionEffectTag.UNKNOWN},
     help = "The multiplier by which to increase the retry delay on transient errors."
   )
   public double experimentalRemoteRetryMultiplier;
@@ -199,6 +209,8 @@ public final class RemoteOptions extends OptionsBase {
     name = "experimental_remote_retry_jitter",
     defaultValue = "0.1",
     category = "remote",
+    documentationCategory = OptionDocumentationCategory.UNCATEGORIZED,
+    effectTags = {OptionEffectTag.UNKNOWN},
     help = "The random factor to apply to retry delays on transient errors."
   )
   public double experimentalRemoteRetryJitter;
-- 
cgit v1.2.3