aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main/java/com/google/devtools/build/lib/buildeventservice
diff options
context:
space:
mode:
authorGravatar ccalvarin <ccalvarin@google.com>2017-06-27 17:58:35 +0200
committerGravatar Marcel Hlopko <hlopko@google.com>2017-06-28 10:17:40 +0200
commit3bc1547a5cd78bd6639d968b3cfddbe26b1c31d5 (patch)
treead80da2596d9150632ca6a1f1510060fe849fa3a /src/main/java/com/google/devtools/build/lib/buildeventservice
parent9b394a24dc65c794242e98a8a41eb8a60c78367b (diff)
Add the default category and tag to all options.
Move the default from the annotation to every mention. This makes the incompleteness explicit. Will add the defaults to test targets in a separate change. Once all dependencies are cleaned up, the Option annotation will no longer allow options without the documentationCategory or effectTag, to prevent new options being added without categories while we migrate to the new option categorization. PiperOrigin-RevId: 160281252
Diffstat (limited to 'src/main/java/com/google/devtools/build/lib/buildeventservice')
-rw-r--r--src/main/java/com/google/devtools/build/lib/buildeventservice/BuildEventServiceOptions.java59
1 files changed, 37 insertions, 22 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/buildeventservice/BuildEventServiceOptions.java b/src/main/java/com/google/devtools/build/lib/buildeventservice/BuildEventServiceOptions.java
index 338cd5b950..f2ea1c39d1 100644
--- a/src/main/java/com/google/devtools/build/lib/buildeventservice/BuildEventServiceOptions.java
+++ b/src/main/java/com/google/devtools/build/lib/buildeventservice/BuildEventServiceOptions.java
@@ -16,8 +16,10 @@ package com.google.devtools.build.lib.buildeventservice;
import com.google.devtools.common.options.Converter;
import com.google.devtools.common.options.Option;
+import com.google.devtools.common.options.OptionDocumentationCategory;
import com.google.devtools.common.options.OptionsBase;
import com.google.devtools.common.options.OptionsParsingException;
+import com.google.devtools.common.options.proto.OptionFilters.OptionEffectTag;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.joda.time.Duration;
@@ -26,44 +28,57 @@ import org.joda.time.Duration;
public class BuildEventServiceOptions extends OptionsBase {
@Option(
- name = "bes_backend",
- defaultValue = "",
- help = "Specifies the build event service (BES) backend endpoint as HOST or HOST:PORT. "
- + "Disabled by default."
+ name = "bes_backend",
+ defaultValue = "",
+ documentationCategory = OptionDocumentationCategory.UNCATEGORIZED,
+ effectTags = {OptionEffectTag.UNKNOWN},
+ help =
+ "Specifies the build event service (BES) backend endpoint as HOST or HOST:PORT. "
+ + "Disabled by default."
)
public String besBackend;
@Option(
- name = "bes_timeout",
- defaultValue = "0s",
- converter = DurationConverter.class,
- help = "Specifies how long bazel should wait for the BES/BEP upload to complete after the "
- + "build and tests have finished. A valid timeout is a natural number followed by a "
- + "unit: Days (d), hours (h), minutes (m), seconds (s), and milliseconds (ms). The "
- + "default value is '0' which means that there is no timeout and that the upload will "
- + "continue in the background after a build has finished."
+ name = "bes_timeout",
+ defaultValue = "0s",
+ converter = DurationConverter.class,
+ documentationCategory = OptionDocumentationCategory.UNCATEGORIZED,
+ effectTags = {OptionEffectTag.UNKNOWN},
+ help =
+ "Specifies how long bazel should wait for the BES/BEP upload to complete after the "
+ + "build and tests have finished. A valid timeout is a natural number followed by a "
+ + "unit: Days (d), hours (h), minutes (m), seconds (s), and milliseconds (ms). The "
+ + "default value is '0' which means that there is no timeout and that the upload will "
+ + "continue in the background after a build has finished."
)
public Duration besTimeout;
@Option(
- name = "bes_best_effort",
- defaultValue = "true",
- help = "Specifies whether a failure to upload the BES protocol should also result in a build "
- + "failure. If 'true', bazel exits with ExitCode.PUBLISH_ERROR. (defaults to 'true')."
+ name = "bes_best_effort",
+ defaultValue = "true",
+ documentationCategory = OptionDocumentationCategory.UNCATEGORIZED,
+ effectTags = {OptionEffectTag.UNKNOWN},
+ help =
+ "Specifies whether a failure to upload the BES protocol should also result in a build "
+ + "failure. If 'true', bazel exits with ExitCode.PUBLISH_ERROR. (defaults to 'true')."
)
public boolean besBestEffort;
@Option(
- name = "bes_lifecycle_events",
- defaultValue = "true",
- help = "Specifies whether to publish BES lifecycle events. (defaults to 'true')."
+ name = "bes_lifecycle_events",
+ defaultValue = "true",
+ documentationCategory = OptionDocumentationCategory.UNCATEGORIZED,
+ effectTags = {OptionEffectTag.UNKNOWN},
+ help = "Specifies whether to publish BES lifecycle events. (defaults to 'true')."
)
public boolean besLifecycleEvents;
@Option(
- name = "project_id",
- defaultValue = "null",
- help = "Specifies the BES project identifier. Defaults to null."
+ name = "project_id",
+ defaultValue = "null",
+ documentationCategory = OptionDocumentationCategory.UNCATEGORIZED,
+ effectTags = {OptionEffectTag.UNKNOWN},
+ help = "Specifies the BES project identifier. Defaults to null."
)
public String projectId;