Add // NOTCONSOLE to docs

We have 1074 snippets that look like they should be converted to `// CONSOLE`. At least that is what `gradle docs:listConsoleCandidates` says. This adds `// NOTCONSOLE` to explicitly mark snippets that *shouldn't* be converted to `// CONSOLE`. After marking the blindingly obvious ones this cuts the remaining snippet count to 1032.

Author: nik9000

buildSrc/src/main/groovy/org/elasticsearch/gradle/doc/DocsTestPlugin.groovy

@@ -42,8 +42,8 @@ public class DocsTestPlugin extends RestTestPlugin {
  'List snippets that probably should be marked // CONSOLE'
  listConsoleCandidates.perSnippet {
  if (
- it.console   // Already marked, nothing to do
- || it.testResponse // It is a response
+ it.console != null // Already marked, nothing to do
+ || it.testResponse  // It is a response
  ) {
  return
  }

buildSrc/src/main/groovy/org/elasticsearch/gradle/doc/SnippetsTask.groovy

@@ -114,23 +114,38 @@ public class SnippetsTask extends DefaultTask {
  return
  }
  if (line ==~ /\/\/\s*AUTOSENSE\s*/) {
- throw new InvalidUserDataException("AUTOSENSE has been " +
- "replaced by CONSOLE. Use that instead at " +
- "$file:$lineNumber")
+ throw new InvalidUserDataException("$file:$lineNumber: "
+ + "AUTOSENSE has been replaced by CONSOLE.")
  }
  if (line ==~ /\/\/\s*CONSOLE\s*/) {
  if (snippet == null) {
- throw new InvalidUserDataException("CONSOLE not " +
- "paired with a snippet at $file:$lineNumber")
+ throw new InvalidUserDataException("$file:$lineNumber: "
+ + "CONSOLE not paired with a snippet")
+ }
+ if (snippet.console != null) {
+ throw new InvalidUserDataException("$file:$lineNumber: "
+ + "Can't be both CONSOLE and NOTCONSOLE")
  }
  snippet.console = true
  return
  }
+ if (line ==~ /\/\/\s*NOTCONSOLE\s*/) {
+ if (snippet == null) {
+ throw new InvalidUserDataException("$file:$lineNumber: "
+ + "NOTCONSOLE not paired with a snippet")
+ }
+ if (snippet.console != null) {
+ throw new InvalidUserDataException("$file:$lineNumber: "
+ + "Can't be both CONSOLE and NOTCONSOLE")
+ }
+ snippet.console = false
+ return
+ }
  matcher = line =~ /\/\/\s*TEST(\[(.+)\])?\s*/
  if (matcher.matches()) {
  if (snippet == null) {
- throw new InvalidUserDataException("TEST not " +
- "paired with a snippet at $file:$lineNumber")
+ throw new InvalidUserDataException("$file:$lineNumber: "
+ + "TEST not paired with a snippet at ")
  }
  snippet.test = true
  if (matcher.group(2) != null) {
@@ -172,8 +187,8 @@ public class SnippetsTask extends DefaultTask {
  matcher = line =~ /\/\/\s*TESTRESPONSE(\[(.+)\])?\s*/
  if (matcher.matches()) {
  if (snippet == null) {
- throw new InvalidUserDataException("TESTRESPONSE not " +
- "paired with a snippet at $file:$lineNumber")
+ throw new InvalidUserDataException("$file:$lineNumber: "
+ + "TESTRESPONSE not paired with a snippet")
  }
  snippet.testResponse = true
  if (matcher.group(2) != null) {
@@ -226,7 +241,7 @@ public class SnippetsTask extends DefaultTask {
  int end = NOT_FINISHED
  String contents
 
- boolean console = false
+ Boolean console = null
  boolean test = false
  boolean testResponse = false
  boolean testSetup = false
@@ -243,8 +258,8 @@ public class SnippetsTask extends DefaultTask {
  if (language != null) {
  result += "($language)"
  }
- if (console) {
- result += '// CONSOLE'
+ if (console != null) {
+ result += console ? '// CONSOLE' : '// NOTCONSOLE'
  }
  if (test) {
  result += '// TEST'

docs/plugins/analysis-icu.asciidoc

@@ -17,6 +17,7 @@ This plugin can be installed using the plugin manager:
 ----------------------------------------------------------------
 sudo bin/elasticsearch-plugin install analysis-icu
 ----------------------------------------------------------------
+// NOTCONSOLE
 
 The plugin must be installed on every node in the cluster, and each node must
 be restarted after installation.
@@ -31,6 +32,7 @@ The plugin can be removed with the following command:
 ----------------------------------------------------------------
 sudo bin/elasticsearch-plugin remove analysis-icu
 ----------------------------------------------------------------
+// NOTCONSOLE
 
 The node must be stopped before removing the plugin.
 

docs/plugins/analysis-kuromoji.asciidoc

@@ -14,6 +14,7 @@ This plugin can be installed using the plugin manager:
 ----------------------------------------------------------------
 sudo bin/elasticsearch-plugin install analysis-kuromoji
 ----------------------------------------------------------------
+// NOTCONSOLE
 
 The plugin must be installed on every node in the cluster, and each node must
 be restarted after installation.
@@ -28,6 +29,7 @@ The plugin can be removed with the following command:
 ----------------------------------------------------------------
 sudo bin/elasticsearch-plugin remove analysis-kuromoji
 ----------------------------------------------------------------
+// NOTCONSOLE
 
 The node must be stopped before removing the plugin.
 

docs/plugins/analysis-phonetic.asciidoc

@@ -15,6 +15,7 @@ This plugin can be installed using the plugin manager:
 ----------------------------------------------------------------
 sudo bin/elasticsearch-plugin install analysis-phonetic
 ----------------------------------------------------------------
+// NOTCONSOLE
 
 The plugin must be installed on every node in the cluster, and each node must
 be restarted after installation.
@@ -29,6 +30,7 @@ The plugin can be removed with the following command:
 ----------------------------------------------------------------
 sudo bin/elasticsearch-plugin remove analysis-phonetic
 ----------------------------------------------------------------
+// NOTCONSOLE
 
 The node must be stopped before removing the plugin.
 

docs/plugins/analysis-smartcn.asciidoc

@@ -20,6 +20,7 @@ This plugin can be installed using the plugin manager:
 ----------------------------------------------------------------
 sudo bin/elasticsearch-plugin install analysis-smartcn
 ----------------------------------------------------------------
+// NOTCONSOLE
 
 The plugin must be installed on every node in the cluster, and each node must
 be restarted after installation.
@@ -34,6 +35,7 @@ The plugin can be removed with the following command:
 ----------------------------------------------------------------
 sudo bin/elasticsearch-plugin remove analysis-smartcn
 ----------------------------------------------------------------
+// NOTCONSOLE
 
 The node must be stopped before removing the plugin.
 
@@ -45,4 +47,3 @@ The plugin provides the `smartcn` analyzer and `smartcn_tokenizer` tokenizer,
 which are not configurable.
 
 NOTE: The `smartcn_word` token filter and `smartcn_sentence` have been deprecated.
-

docs/plugins/analysis-stempel.asciidoc

@@ -17,6 +17,7 @@ This plugin can be installed using the plugin manager:
 ----------------------------------------------------------------
 sudo bin/elasticsearch-plugin install analysis-stempel
 ----------------------------------------------------------------
+// NOTCONSOLE
 
 The plugin must be installed on every node in the cluster, and each node must
 be restarted after installation.
@@ -31,6 +32,7 @@ The plugin can be removed with the following command:
 ----------------------------------------------------------------
 sudo bin/elasticsearch-plugin remove analysis-stempel
 ----------------------------------------------------------------
+// NOTCONSOLE
 
 The node must be stopped before removing the plugin.
 
@@ -40,4 +42,3 @@ The node must be stopped before removing the plugin.
 
 The plugin provides the `polish` analyzer and `polish_stem` token filter,
 which are not configurable.
-

docs/plugins/discovery-azure-classic.asciidoc

@@ -17,6 +17,7 @@ This plugin can be installed using the plugin manager:
 ----------------------------------------------------------------
 sudo bin/elasticsearch-plugin install discovery-azure-classic
 ----------------------------------------------------------------
+// NOTCONSOLE
 
 The plugin must be installed on every node in the cluster, and each node must
 be restarted after installation.
@@ -31,6 +32,7 @@ The plugin can be removed with the following command:
 ----------------------------------------------------------------
 sudo bin/elasticsearch-plugin remove discovery-azure-classic
 ----------------------------------------------------------------
+// NOTCONSOLE
 
 The node must be stopped before removing the plugin.
 

docs/plugins/discovery-ec2.asciidoc

@@ -13,6 +13,7 @@ This plugin can be installed using the plugin manager:
 ----------------------------------------------------------------
 sudo bin/elasticsearch-plugin install discovery-ec2
 ----------------------------------------------------------------
+// NOTCONSOLE
 
 The plugin must be installed on every node in the cluster, and each node must
 be restarted after installation.
@@ -27,6 +28,7 @@ The plugin can be removed with the following command:
 ----------------------------------------------------------------
 sudo bin/elasticsearch-plugin remove discovery-ec2
 ----------------------------------------------------------------
+// NOTCONSOLE
 
 The node must be stopped before removing the plugin.
 
@@ -140,7 +142,7 @@ discovery:
 You must also set `cloud.aws.region` if you are not using default AWS region. See <<discovery-ec2-usage-region>> for details.
 
 The ec2 discovery is using the same credentials as the rest of the AWS services provided by this plugin (`repositories`).
-See <<discovery-ec2-usage>> for details. 
+See <<discovery-ec2-usage>> for details.
 
 The following are a list of settings (prefixed with `discovery.ec2`) that can further control the discovery:
 
@@ -267,7 +269,7 @@ When selecting disk please be aware of the following order of preference:
 * http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html[Instance Store] - When running clusters of larger size and with replicas the ephemeral nature of Instance Store is ideal since Elasticsearch can tolerate the loss of shards. With Instance Store one gets the performance benefit of having disk physically attached to the host running the instance and also the cost benefit of avoiding paying extra for EBS.
 
 
-Prefer https://aws.amazon.com/amazon-linux-ami/[Amazon Linux AMIs] as since Elasticsearch runs on the JVM, OS dependencies are very minimal and one can benefit from the lightweight nature, support, and performance tweaks specific to EC2 that the Amazon Linux AMIs offer. 
+Prefer https://aws.amazon.com/amazon-linux-ami/[Amazon Linux AMIs] as since Elasticsearch runs on the JVM, OS dependencies are very minimal and one can benefit from the lightweight nature, support, and performance tweaks specific to EC2 that the Amazon Linux AMIs offer.
 
 ===== Networking
 * Networking throttling takes place on smaller instance types in both the form of https://lab.getbase.com/how-we-discovered-limitations-on-the-aws-tcp-stack/[bandwidth and number of connections]. Therefore if large number of connections are needed and networking is becoming a bottleneck, avoid https://aws.amazon.com/ec2/instance-types/[instance types] with networking labeled as `Moderate` or `Low`.

docs/plugins/discovery-gce.asciidoc

@@ -13,6 +13,7 @@ This plugin can be installed using the plugin manager:
 ----------------------------------------------------------------
 sudo bin/elasticsearch-plugin install discovery-gce
 ----------------------------------------------------------------
+// NOTCONSOLE
 
 The plugin must be installed on every node in the cluster, and each node must
 be restarted after installation.
@@ -27,6 +28,7 @@ The plugin can be removed with the following command:
 ----------------------------------------------------------------
 sudo bin/elasticsearch-plugin remove discovery-gce
 ----------------------------------------------------------------
+// NOTCONSOLE
 
 The node must be stopped before removing the plugin.