From ae4a3d5bff1700156b448e1203c6454967074a28 Mon Sep 17 00:00:00 2001
From: Thomas Broyer <t.broyer@ltgt.net>
Date: Fri, 30 Apr 2021 14:47:02 -0700
Subject: Remove "Processor Resilience" section now that Auto Common 1.0 has
 been released

Fixes #1085

COPYBARA_INTEGRATE_REVIEW=https://github.com/google/auto/pull/1085 from tbroyer:patch-1 3468b1253f4f4f1b5276fed94f9db1ea99d614e9
PiperOrigin-RevId: 371409446
---
 common/README.md | 80 +++++++++++++-------------------------------------------
 1 file changed, 18 insertions(+), 62 deletions(-)

(limited to 'common')

diff --git a/common/README.md b/common/README.md
index 990aa31b..9f8eb79e 100644
--- a/common/README.md
+++ b/common/README.md
@@ -1,28 +1,30 @@
-Auto Common Utilities
-========
+# Auto Common Utilities
 
 ## Overview
 
-The Auto project has a set of common utilities to help ease use of the annotation processing
-environment.
+The Auto project has a set of common utilities to help ease use of the
+annotation processing environment.
 
 ## Utility classes of note
 
-  * MoreTypes - utilities and Equivalence wrappers for TypeMirror and related subtypes
-  * MoreElements - utilities for Element and related subtypes
-  * SuperficialValidation - very simple scanner to ensure an Element is valid and free from
-    distortion from upstream compilation errors
-  * Visibility - utilities for working with Elements' visibility levels (public, protected, etc.)
-  * BasicAnnotationProcessor/ProcessingStep - simple types that
-    - implement a validating annotation processor
-    - defer invalid elements until later
-    - break processor actions into multiple steps (which may each handle different annotations)
+*   MoreTypes - utilities and Equivalence wrappers for TypeMirror and related
+    subtypes
+*   MoreElements - utilities for Element and related subtypes
+*   SuperficialValidation - very simple scanner to ensure an Element is valid
+    and free from distortion from upstream compilation errors
+*   Visibility - utilities for working with Elements' visibility levels (public,
+    protected, etc.)
+*   BasicAnnotationProcessor/ProcessingStep - simple types that
+    -   implement a validating annotation processor
+    -   defer invalid elements until later
+    -   break processor actions into multiple steps (which may each handle
+        different annotations)
 
 ## Usage/Setup
 
-Auto common utilities have a standard [Maven](http://maven.apache.org) setup which can also be
-used from Gradle, Ivy, Ant, or other systems which consume binary artifacts from the central Maven
-binary artifact repositories.
+Auto common utilities have a standard [Maven](http://maven.apache.org) setup
+which can also be used from Gradle, Ivy, Ant, or other systems which consume
+binary artifacts from the central Maven binary artifact repositories.
 
 ```xml
 <dependency>
@@ -31,49 +33,3 @@ binary artifact repositories.
   <version>1.0-SNAPSHOT</version> <!-- or use a known release version -->
 </dependency>
 ```
-
-## Processor Resilience
-
-Auto Common Utilities is used by a variety of annotation processors in Google and new versions
-may have breaking changes.  Users of auto-common are urged to use
-[shade](https://maven.apache.org/plugins/maven-shade-plugin/) or
-[jarjar](https://code.google.com/p/jarjar/) (or something similar) in packaging their processors
-so that conflicting versions of this library do not adversely interact with each other.
-
-For example, in a Maven build you can repackage `com.google.auto.common` into
-`your.processor.shaded.auto.common` like this:
-
-```xml
-<project>
-  <!-- your other config -->
-  <build>
-    <plugins>
-      <plugin>
-        <artifactId>maven-shade-plugin</artifactId>
-        <executions>
-          <execution>
-            <phase>package</phase>
-            <goals>
-              <goal>shade</goal>
-            </goals>
-            <configuration>
-              <artifactSet>
-                <excludes>
-                  <!-- exclude dependencies you don't want to bundle in your processor -->
-                </excludes>
-              </artifactSet>
-              <relocations>
-                <relocation>
-                  <pattern>com.google.auto.common</pattern>
-                  <shadedPattern>your.processor.shaded.auto.common</shadedPattern>
-                </relocation>
-              </relocations>
-            </configuration>
-          </execution>
-        </executions>
-      </plugin>
-    </plugins>
-  </build>
-</project>
-```
-
-- 
cgit v1.2.3