// Copyright 2014 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;

import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableSet;

/**
 * Various constants required by Bazel.
 *
 * <p>The extra {@code .toString()} calls are there so that javac doesn't inline these constants
 * so that we can replace this class file within the Bazel binary.
 */
public class Constants {
  private Constants() {}

  public static final String PRODUCT_NAME = "bazel";
  public static final ImmutableList<String> DEFAULT_PACKAGE_PATH = ImmutableList.of("%workspace%");
  public static final String MAIN_RULE_CLASS_PROVIDER =
      "com.google.devtools.build.lib.bazel.rules.BazelRuleClassProvider";

  public static final String NATIVE_DEPS_LIB_SUFFIX = "_nativedeps";

  public static final String ANDROID_DEFAULT_SDK = "//external:android/sdk".toString();
  public static final String ANDROID_DEFAULT_CROSSTOOL = "//external:android/crosstool".toString();
  public static final ImmutableList<String> ANDROID_DEFAULT_FAT_APK_CPUS =
      ImmutableList.<String>of("armeabi-v7a");
  public static final String TOOLS_REPOSITORY = "@bazel_tools".toString();

  /**
   * Whether C++ include scanning should be disabled no matter what the --cc_include_scanning flag
   * says.
   */
  public static final boolean ALLOW_CC_INCLUDE_SCANNING = new Boolean(false).booleanValue();
}

@@ -756,43 +756,265 @@
 %0A * 
-Various constants required by Bazel
+A temporary class of constants; these encode differences between Google's internal setup and%0A * Bazel. We're working to remove this class, which requires cleaning up our internal code base.%0A * Please don't add anything here unless you know what you're doing
 .%0A *
@@ -1164,17 +1164,9 @@
 hin 
-the Bazel
+a
  bin
@@ -1181,16 +1181,22 @@
 %0Apublic 
+final 
 class Co
@@ -1237,58 +1237,226 @@
 %0A%0A  
-public static final String PRODUCT_NAME = %22bazel%22;
+// Google's internal name for Bazel is 'Blaze', and it will take some more time to change that.%0A  public static final String PRODUCT_NAME = %22bazel%22;%0A%0A  // Default value for the --package_path flag if not otherwise set.
 %0A  p
@@ -1551,16 +1551,106 @@
 pace%25%22);
+%0A%0A  // The rule documentation generator iterates over all rules in the class by this name.
 %0A  publi
@@ -1769,24 +1769,121 @@
 Provider%22;%0A%0A
+  // Native Java deps are all linked into a single file, which is named with this value + %22.so%22.%0A
   public sta
@@ -1940,16 +1940,77 @@
 deps%22;%0A%0A
+  // Locations of implicit Android SDK and NDK dependencies.%0A
   public
@@ -2181,32 +2181,109 @@
 ol%22.toString();%0A
+  // If the --fat_apk_cpu flag is not set, we use this as the default value.%0A
   public static 
@@ -2387,16 +2387,114 @@
 i-v7a%22);
+%0A%0A  // Most other tools dependencies use this; we plan to split it into per-language repositories.
 %0A  publi
@@ -2569,36 +2569,27 @@
 %0A  /
-**%0A   * Whether C++ 
+/ The --cc_
 include
- 
+_
 scan
@@ -2597,89 +2597,135 @@
 ing 
-should be disabled no matter what the --cc_include_scanning flag%0A   * says.%0A   */
+flag does not work in Bazel, and will be removed imminently.%0A  // We currently use this constant to disable it unconditionally.
 %0A  p

Update the documentation for Constants.java.