diff options
Diffstat (limited to 'src/main/java/com/google')
12 files changed, 84 insertions, 80 deletions
diff --git a/src/main/java/com/google/devtools/build/lib/analysis/BuildView.java b/src/main/java/com/google/devtools/build/lib/analysis/BuildView.java index 57ba8e0e14..9abeb1a561 100644 --- a/src/main/java/com/google/devtools/build/lib/analysis/BuildView.java +++ b/src/main/java/com/google/devtools/build/lib/analysis/BuildView.java @@ -186,8 +186,8 @@ public class BuildView { abbrev = 'k', defaultValue = "false", category = "strategy", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.EXECUTION_STRATEGY, + effectTags = {OptionEffectTag.EAGERNESS_TO_EXIT}, help = "Continue as much as possible after an error. While the target that failed, and those " + "that depend on it, cannot be analyzed (or built), the other prerequisites of " diff --git a/src/main/java/com/google/devtools/build/lib/bazel/commands/FetchOptions.java b/src/main/java/com/google/devtools/build/lib/bazel/commands/FetchOptions.java index 2b47bb99b9..1743c45475 100644 --- a/src/main/java/com/google/devtools/build/lib/bazel/commands/FetchOptions.java +++ b/src/main/java/com/google/devtools/build/lib/bazel/commands/FetchOptions.java @@ -28,13 +28,11 @@ public class FetchOptions extends OptionsBase { abbrev = 'k', defaultValue = "false", category = "strategy", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.EXECUTION_STRATEGY, + effectTags = {OptionEffectTag.EAGERNESS_TO_EXIT}, help = - "Continue as much as possible after an error. While the " - + "target that failed and those that depend on it cannot be " - + "analyzed, other prerequisites of these " - + "targets can be." + "Continue as much as possible after an error. While the target that failed and those " + + "that depend on it cannot be analyzed, other prerequisites of these targets can be." ) public boolean keepGoing; } diff --git a/src/main/java/com/google/devtools/build/lib/runtime/TerminalTestResultNotifier.java b/src/main/java/com/google/devtools/build/lib/runtime/TerminalTestResultNotifier.java index de0f371fdb..af05b032cc 100644 --- a/src/main/java/com/google/devtools/build/lib/runtime/TerminalTestResultNotifier.java +++ b/src/main/java/com/google/devtools/build/lib/runtime/TerminalTestResultNotifier.java @@ -56,8 +56,8 @@ public class TerminalTestResultNotifier implements TestResultNotifier { name = "verbose_test_summary", defaultValue = "true", category = "verbosity", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.LOGGING, + effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, help = "If true, print additional information (timing, number of failed runs, etc) in the" + " test summary." @@ -68,8 +68,8 @@ public class TerminalTestResultNotifier implements TestResultNotifier { name = "test_verbose_timeout_warnings", defaultValue = "false", category = "verbosity", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.LOGGING, + effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, help = "If true, print additional warnings when the actual test execution time does not " + "match the timeout defined by the test (whether implied or explicit)." diff --git a/src/main/java/com/google/devtools/build/lib/runtime/commands/CanonicalizeCommand.java b/src/main/java/com/google/devtools/build/lib/runtime/commands/CanonicalizeCommand.java index f6c905826c..c706bd04b4 100644 --- a/src/main/java/com/google/devtools/build/lib/runtime/commands/CanonicalizeCommand.java +++ b/src/main/java/com/google/devtools/build/lib/runtime/commands/CanonicalizeCommand.java @@ -55,8 +55,8 @@ public final class CanonicalizeCommand implements BlazeCommand { name = "for_command", defaultValue = "build", category = "misc", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.GENERIC_INPUTS, + effectTags = {OptionEffectTag.AFFECTS_OUTPUTS, OptionEffectTag.TERMINAL_OUTPUT}, help = "The command for which the options should be canonicalized." ) public String forCommand; @@ -64,8 +64,8 @@ public final class CanonicalizeCommand implements BlazeCommand { @Option( name = "invocation_policy", defaultValue = "", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.GENERIC_INPUTS, + effectTags = {OptionEffectTag.AFFECTS_OUTPUTS, OptionEffectTag.TERMINAL_OUTPUT}, help = "Applies an invocation policy to the options to be canonicalized." ) public String invocationPolicy; @@ -73,8 +73,8 @@ public final class CanonicalizeCommand implements BlazeCommand { @Option( name = "canonicalize_policy", defaultValue = "false", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.OUTPUT_SELECTION, + effectTags = {OptionEffectTag.AFFECTS_OUTPUTS, OptionEffectTag.TERMINAL_OUTPUT}, help = "Output the canonical policy, after expansion and filtering. To keep the output " + "clean, the canonicalized command arguments will NOT be shown when this option is " @@ -86,8 +86,8 @@ public final class CanonicalizeCommand implements BlazeCommand { @Option( name = "show_warnings", defaultValue = "false", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.OUTPUT_SELECTION, + effectTags = {OptionEffectTag.AFFECTS_OUTPUTS, OptionEffectTag.TERMINAL_OUTPUT}, help = "Output parser warnings to standard error (e.g. for conflicting flag options)." ) public boolean showWarnings; @@ -103,7 +103,7 @@ public final class CanonicalizeCommand implements BlazeCommand { name = "flag_clash_canary", defaultValue = "false", documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, - effectTags = {OptionEffectTag.UNKNOWN} + effectTags = {OptionEffectTag.NO_OP} ) public boolean flagClashCanary; @@ -111,7 +111,7 @@ public final class CanonicalizeCommand implements BlazeCommand { name = "flag_clash_canary_expander1", defaultValue = "null", documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, - effectTags = {OptionEffectTag.UNKNOWN}, + effectTags = {OptionEffectTag.NO_OP}, expansion = {"--flag_clash_canary=1"} ) public Void flagClashCanaryExpander1; @@ -120,7 +120,7 @@ public final class CanonicalizeCommand implements BlazeCommand { name = "flag_clash_canary_expander2", defaultValue = "null", documentationCategory = OptionDocumentationCategory.UNDOCUMENTED, - effectTags = {OptionEffectTag.UNKNOWN}, + effectTags = {OptionEffectTag.NO_OP}, expansion = {"--flag_clash_canary=0"} ) public Void flagClashCanaryExpander2; diff --git a/src/main/java/com/google/devtools/build/lib/runtime/commands/CleanCommand.java b/src/main/java/com/google/devtools/build/lib/runtime/commands/CleanCommand.java index 5121d4dd09..e4cb3ac7a3 100644 --- a/src/main/java/com/google/devtools/build/lib/runtime/commands/CleanCommand.java +++ b/src/main/java/com/google/devtools/build/lib/runtime/commands/CleanCommand.java @@ -62,8 +62,8 @@ public final class CleanCommand implements BlazeCommand { name = "clean_style", defaultValue = "", category = "clean", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.OUTPUT_SELECTION, + effectTags = {OptionEffectTag.HOST_MACHINE_RESOURCE_OPTIMIZATIONS}, help = "Can be 'expunge', 'expunge_async', or 'async'." ) public String cleanStyle; @@ -73,8 +73,8 @@ public final class CleanCommand implements BlazeCommand { defaultValue = "null", category = "clean", expansion = "--clean_style=expunge", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.OUTPUT_SELECTION, + effectTags = {OptionEffectTag.HOST_MACHINE_RESOURCE_OPTIMIZATIONS}, help = "If specified, clean removes the entire working tree for this %{product} " + "instance, which includes all %{product}-created temporary and build output " @@ -87,8 +87,8 @@ public final class CleanCommand implements BlazeCommand { defaultValue = "null", category = "clean", expansion = "--clean_style=expunge_async", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.OUTPUT_SELECTION, + effectTags = {OptionEffectTag.HOST_MACHINE_RESOURCE_OPTIMIZATIONS}, help = "If specified, clean asynchronously removes the entire working tree for " + "this %{product} instance, which includes all %{product}-created temporary and " @@ -103,8 +103,8 @@ public final class CleanCommand implements BlazeCommand { defaultValue = "null", category = "clean", expansion = "--clean_style=async", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.OUTPUT_SELECTION, + effectTags = {OptionEffectTag.HOST_MACHINE_RESOURCE_OPTIMIZATIONS}, help = "If specified, clean asynchronously removes the entire working tree for " + "this %{product} instance, which includes all %{product}-created temporary and " diff --git a/src/main/java/com/google/devtools/build/lib/runtime/commands/DumpCommand.java b/src/main/java/com/google/devtools/build/lib/runtime/commands/DumpCommand.java index c6b80650ea..b2aeef256b 100644 --- a/src/main/java/com/google/devtools/build/lib/runtime/commands/DumpCommand.java +++ b/src/main/java/com/google/devtools/build/lib/runtime/commands/DumpCommand.java @@ -67,8 +67,8 @@ public class DumpCommand implements BlazeCommand { name = "packages", defaultValue = "false", category = "verbosity", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.OUTPUT_SELECTION, + effectTags = {OptionEffectTag.BAZEL_MONITORING}, help = "Dump package cache content." ) public boolean dumpPackages; @@ -77,8 +77,8 @@ public class DumpCommand implements BlazeCommand { name = "vfs", defaultValue = "false", category = "verbosity", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.OUTPUT_SELECTION, + effectTags = {OptionEffectTag.BAZEL_MONITORING}, help = "Dump virtual filesystem cache content." ) public boolean dumpVfs; @@ -87,8 +87,8 @@ public class DumpCommand implements BlazeCommand { name = "action_cache", defaultValue = "false", category = "verbosity", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.OUTPUT_SELECTION, + effectTags = {OptionEffectTag.BAZEL_MONITORING}, help = "Dump action cache content." ) public boolean dumpActionCache; @@ -97,8 +97,8 @@ public class DumpCommand implements BlazeCommand { name = "rule_classes", defaultValue = "false", category = "verbosity", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.OUTPUT_SELECTION, + effectTags = {OptionEffectTag.BAZEL_MONITORING}, help = "Dump rule classes." ) public boolean dumpRuleClasses; @@ -108,8 +108,8 @@ public class DumpCommand implements BlazeCommand { defaultValue = "off", category = "verbosity", converter = SkyframeDumpEnumConverter.class, - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.OUTPUT_SELECTION, + effectTags = {OptionEffectTag.BAZEL_MONITORING}, help = "Dump Skyframe graph: 'off', 'summary', or 'detailed'." ) public SkyframeDumpOption dumpSkyframe; diff --git a/src/main/java/com/google/devtools/build/lib/runtime/commands/HelpCommand.java b/src/main/java/com/google/devtools/build/lib/runtime/commands/HelpCommand.java index a3669efccc..8c3821bff6 100644 --- a/src/main/java/com/google/devtools/build/lib/runtime/commands/HelpCommand.java +++ b/src/main/java/com/google/devtools/build/lib/runtime/commands/HelpCommand.java @@ -85,8 +85,8 @@ public final class HelpCommand implements BlazeCommand { category = "help", defaultValue = "medium", converter = Converters.HelpVerbosityConverter.class, - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.LOGGING, + effectTags = {OptionEffectTag.AFFECTS_OUTPUTS, OptionEffectTag.TERMINAL_OUTPUT}, help = "Select the verbosity of the help command." ) public OptionsParser.HelpVerbosity helpVerbosity; @@ -97,8 +97,8 @@ public final class HelpCommand implements BlazeCommand { defaultValue = "null", category = "help", expansion = {"--help_verbosity=long"}, - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.LOGGING, + effectTags = {OptionEffectTag.AFFECTS_OUTPUTS, OptionEffectTag.TERMINAL_OUTPUT}, help = "Show full description of each option, instead of just its name." ) public Void showLongFormOptions; @@ -108,8 +108,8 @@ public final class HelpCommand implements BlazeCommand { defaultValue = "null", category = "help", expansion = {"--help_verbosity=short"}, - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.LOGGING, + effectTags = {OptionEffectTag.AFFECTS_OUTPUTS, OptionEffectTag.TERMINAL_OUTPUT}, help = "Show only the names of the options, not their types or meanings." ) public Void showShortFormOptions; diff --git a/src/main/java/com/google/devtools/build/lib/runtime/commands/InfoCommand.java b/src/main/java/com/google/devtools/build/lib/runtime/commands/InfoCommand.java index 6ce21e2db5..054f5ddff3 100644 --- a/src/main/java/com/google/devtools/build/lib/runtime/commands/InfoCommand.java +++ b/src/main/java/com/google/devtools/build/lib/runtime/commands/InfoCommand.java @@ -67,8 +67,8 @@ public class InfoCommand implements BlazeCommand { name = "show_make_env", defaultValue = "false", category = "misc", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.LOGGING, + effectTags = {OptionEffectTag.AFFECTS_OUTPUTS, OptionEffectTag.TERMINAL_OUTPUT}, help = "Include the \"Make\" environment in the output." ) public boolean showMakeEnvironment; diff --git a/src/main/java/com/google/devtools/build/lib/runtime/commands/ProfileCommand.java b/src/main/java/com/google/devtools/build/lib/runtime/commands/ProfileCommand.java index 56b76bf5d5..951e5c490b 100644 --- a/src/main/java/com/google/devtools/build/lib/runtime/commands/ProfileCommand.java +++ b/src/main/java/com/google/devtools/build/lib/runtime/commands/ProfileCommand.java @@ -71,8 +71,8 @@ public final class ProfileCommand implements BlazeCommand { @Option( name = "chart", defaultValue = "true", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.LOGGING, + effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, help = "If --nochart is present, do not include the task chart with --html_details." + " The default is --chart." @@ -82,8 +82,8 @@ public final class ProfileCommand implements BlazeCommand { @Option( name = "combine", defaultValue = "null", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.LOGGING, + effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, help = "If present, the statistics of all given profile files will be combined and output" + " in text/--html format to the file named in the argument. Does not output HTML" @@ -96,8 +96,8 @@ public final class ProfileCommand implements BlazeCommand { abbrev = 'd', converter = DumpConverter.class, defaultValue = "null", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.LOGGING, + effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, help = "output full profile data dump either in human-readable 'text' format or" + " script-friendly 'raw' format, either sorted or unsorted." @@ -107,8 +107,8 @@ public final class ProfileCommand implements BlazeCommand { @Option( name = "html", defaultValue = "false", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.LOGGING, + effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, help = "If present, an HTML file visualizing the tasks of the profiled build is created. " + "The name of the html file is the name of the profile file plus '.html'." @@ -118,8 +118,8 @@ public final class ProfileCommand implements BlazeCommand { @Option( name = "html_pixels_per_second", defaultValue = "50", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.LOGGING, + effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, help = "Defines the scale of the time axis of the task diagram. The unit is " + "pixels per second. Default is 50 pixels per second. " @@ -129,8 +129,8 @@ public final class ProfileCommand implements BlazeCommand { @Option( name = "html_details", defaultValue = "false", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.LOGGING, + effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, help = "If --html_details is present, the task diagram contains all tasks of the profile " + " and performance statistics on user-defined and built-in Skylark functions. " @@ -142,8 +142,8 @@ public final class ProfileCommand implements BlazeCommand { @Option( name = "html_histograms", defaultValue = "false", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.LOGGING, + effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, help = "If --html_histograms and --html_details is present, the HTML output will display" + " histograms for Skylark functions clicked in the statistics table. This will" @@ -155,8 +155,8 @@ public final class ProfileCommand implements BlazeCommand { name = "task_tree", defaultValue = "null", converter = Converters.RegexPatternConverter.class, - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.LOGGING, + effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, help = "Print the tree of profiler tasks from all tasks matching the given regular expression." ) @@ -165,8 +165,8 @@ public final class ProfileCommand implements BlazeCommand { @Option( name = "task_tree_threshold", defaultValue = "50", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.LOGGING, + effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, help = "When printing a task tree, will skip tasks with a duration that is less than the" + " given threshold in milliseconds." @@ -176,8 +176,8 @@ public final class ProfileCommand implements BlazeCommand { @Option( name = "vfs_stats", defaultValue = "false", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.LOGGING, + effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, help = "If present, include VFS path statistics." ) public boolean vfsStats; @@ -185,8 +185,8 @@ public final class ProfileCommand implements BlazeCommand { @Option( name = "vfs_stats_limit", defaultValue = "-1", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.LOGGING, + effectTags = {OptionEffectTag.AFFECTS_OUTPUTS}, help = "Maximum number of VFS path statistics to print." ) public int vfsStatsLimit; diff --git a/src/main/java/com/google/devtools/build/lib/runtime/commands/RunCommand.java b/src/main/java/com/google/devtools/build/lib/runtime/commands/RunCommand.java index c48ad81b3d..8f740eaf21 100644 --- a/src/main/java/com/google/devtools/build/lib/runtime/commands/RunCommand.java +++ b/src/main/java/com/google/devtools/build/lib/runtime/commands/RunCommand.java @@ -96,12 +96,12 @@ public class RunCommand implements BlazeCommand { name = "script_path", category = "run", defaultValue = "null", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.OUTPUT_PARAMETERS, + effectTags = {OptionEffectTag.AFFECTS_OUTPUTS, OptionEffectTag.EXECUTION}, converter = OptionsUtils.PathFragmentConverter.class, help = - "If set, write a shell script to the given file which invokes the " - + "target. If this option is set, the target is not run from %{product}. " + "If set, write a shell script to the given file which invokes the target. " + + "If this option is set, the target is not run from %{product}. " + "Use '%{product} run --script_path=foo //foo && ./foo' to invoke target '//foo' " + "This differs from '%{product} run //foo' in that the %{product} lock is released " + "and the executable is connected to the terminal's stdin." diff --git a/src/main/java/com/google/devtools/build/lib/runtime/commands/ShutdownCommand.java b/src/main/java/com/google/devtools/build/lib/runtime/commands/ShutdownCommand.java index 1b1bfdabbd..09423c0b56 100644 --- a/src/main/java/com/google/devtools/build/lib/runtime/commands/ShutdownCommand.java +++ b/src/main/java/com/google/devtools/build/lib/runtime/commands/ShutdownCommand.java @@ -43,12 +43,11 @@ public final class ShutdownCommand implements BlazeCommand { name = "iff_heap_size_greater_than", defaultValue = "0", category = "misc", - documentationCategory = OptionDocumentationCategory.UNCATEGORIZED, - effectTags = {OptionEffectTag.UNKNOWN}, + documentationCategory = OptionDocumentationCategory.OUTPUT_SELECTION, + effectTags = {OptionEffectTag.LOSES_INCREMENTAL_STATE, OptionEffectTag.EAGERNESS_TO_EXIT}, help = - "Iff non-zero, then shutdown will only shut down the " - + "server if the total memory (in MB) consumed by the JVM " - + "exceeds this value." + "Iff non-zero, then shutdown will only shut down the server if the total memory (in MB) " + + "consumed by the JVM exceeds this value." ) public int heapSizeLimit; } diff --git a/src/main/java/com/google/devtools/common/options/OptionDocumentationCategory.java b/src/main/java/com/google/devtools/common/options/OptionDocumentationCategory.java index e288b13e57..1f27046607 100644 --- a/src/main/java/com/google/devtools/common/options/OptionDocumentationCategory.java +++ b/src/main/java/com/google/devtools/common/options/OptionDocumentationCategory.java @@ -93,4 +93,11 @@ public enum OptionDocumentationCategory { /** This option relates to query output and semantics. */ QUERY, + + /** + * This option specifies or alters a generic input to a Bazel command. This category should only + * be used if the input is generic and does not fall into other categories, such as toolchain- + * specific inputs. + */ + GENERIC_INPUTS, } |