Update japi readme and master config (#55)
* Update japi readme and master config
* Update japi-accumulo-master.xml
Remove old jar
diff --git a/test/compat/japi-compliance/README b/test/compat/japi-compliance/README
deleted file mode 100644
index 0b77050..0000000
--- a/test/compat/japi-compliance/README
+++ /dev/null
@@ -1,53 +0,0 @@
-Title: Java API Compliance Checker Instructions
-Notice: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you 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.
-
-There is a tool that can analyze the difference between APIs called
-japi-compliance[1]. This tool is useful for checking API compatability of
-different Accumulo versions. To run this tool edit the xml files to specify
-the location of accumulo core jars and set the library version. Then run the
-following command.
-
- japi-compliance-checker.pl -skip-deprecated -old japi-accumulo-1.5.xml -new japi-accumulo-1.6.xml -l accumulo
-
-Optionally, you can use the --skip-classes argument with the provided exclude_classes.txt file to skip classes from
-org.apache.accumulo.core.data that aren't in the public API.
-
-This directory should have a library configuration file for each release on supported lines as well as an in-progress
-for whatever version is currently the master branch. The examples below all make use of version-specific library definitions.
-
-When looking at a patch release, you should verify that changes introduced are forwards and backwards compatible, per
-semver.
-
- # Backwards compatibility from x.y.z to x.y.(z+1)
- japi-compliance-checker.pl -old japi-accumulo-1.6.1.xml -new japi-accumulo-1.6.2.xml -l accumulo --skip-classes=exclude_classes.txt
- # Forwards compatibility from x.y.z to x.y.(z+1). Note that the old / new arguments have been swapped.
- japi-compliance-checker.pl -new japi-accumulo-1.6.1.xml -old japi-accumulo-1.6.2.xml -l accumulo --skip-classes=exclude_classes.txt
-
-When looking at a minor release, you should verify that change are backwards compatible, per semver.
-
- # Backwards compatibility from x.y.z to x.(y+1).0
- japi-compliance-checker.pl -old japi-accumulo-1.6.1.xml -new japi-accumulo-1.7.0.xml -l accumulo --skip-classes=exclude_classes.txt
-
-When looking at a major release, you should examine removals to make sure they are not capricious. Specifically, you should ensure that
-they have been deprecated for a full major version.
-
- # Advisory backwards compatibility check from x.y.z to (x+1).0.0
- japi-compliance-checker.pl -old japi-accumulo-1.7.0.xml -new japi-accumulo-2.0.0.xml -l accumulo --skip-classes=exclude_classes.txt
-
-[1]: http://ispras.linuxbase.org/index.php/Java_API_Compliance_Checker
-
diff --git a/test/compat/japi-compliance/README.md b/test/compat/japi-compliance/README.md
new file mode 100644
index 0000000..a68ed52
--- /dev/null
+++ b/test/compat/japi-compliance/README.md
@@ -0,0 +1,48 @@
+# Java API Compliance Checker Instructions
+
+There is a tool that can analyze the difference between APIs called
+[japi-compliance][japi]. This tool is useful for checking API compatability of
+different Accumulo versions. To run this tool edit the xml files to specify
+the location of accumulo core jars and set the library version. Then run the
+following command.
+```bash
+ japi-compliance-checker.pl -skip-deprecated -old japi-accumulo-1.5.xml -new japi-accumulo-1.6.xml -l accumulo
+```
+
+Optionally, you can use the --skip-classes argument with the provided exclude_classes.txt file to skip classes from
+org.apache.accumulo.core.data that aren't in the public API.
+
+This directory should have a library configuration file for each release on supported lines as well as an in-progress
+for whatever version is currently the master branch. The examples below all make use of version-specific library definitions.
+
+When looking at a patch release, you should verify that changes introduced are forwards and backwards compatible, per
+semver.
+
+ ### Backwards compatibility from x.y.z to x.y.(z+1)
+ ```bash
+ japi-compliance-checker.pl -old japi-accumulo-1.6.1.xml -new japi-accumulo-1.6.2.xml -l accumulo --skip-classes=exclude_classes.txt
+ ```
+
+ ### Forwards compatibility from x.y.z to x.y.(z+1). Note that the old / new arguments have been swapped.
+ ```bash
+ japi-compliance-checker.pl -new japi-accumulo-1.6.1.xml -old japi-accumulo-1.6.2.xml -l accumulo --skip-classes=exclude_classes.txt
+ ```
+
+When looking at a minor release, you should verify that change are backwards compatible, per semver.
+
+ ### Backwards compatibility from x.y.z to x.(y+1).0
+ ```bash
+ japi-compliance-checker.pl -old japi-accumulo-1.6.1.xml -new japi-accumulo-1.7.0.xml -l accumulo --skip-classes=exclude_classes.txt
+ ```
+
+When looking at a major release, you should examine removals to make sure they are not capricious. Specifically, you should ensure that
+they have been deprecated for a full major version.
+
+ ### Advisory backwards compatibility check from x.y.z to (x+1).0.0
+ ```bash
+ japi-compliance-checker.pl -old japi-accumulo-1.7.0.xml -new japi-accumulo-2.0.0.xml -l accumulo --skip-classes=exclude_classes.txt
+ ```
+
+
+[japi]: https://lvc.github.io/japi-compliance-checker
+
diff --git a/test/compat/japi-compliance/japi-accumulo-master.xml b/test/compat/japi-compliance/japi-accumulo-master.xml
index af9a6e9..243b488 100644
--- a/test/compat/japi-compliance/japi-accumulo-master.xml
+++ b/test/compat/japi-compliance/japi-accumulo-master.xml
@@ -27,7 +27,6 @@
Then check the relevant pom files to see what the artifact is named.
-->
<archives>
- /path/to/accumulo-client-mapreduce-2.0.0-SNAPSHOT.jar
/path/to/accumulo-core-2.0.0-SNAPSHOT.jar
/path/to/accumulo-minicluster-2.0.0-SNAPSHOT.jar
</archives>
@@ -45,17 +44,16 @@
-->
<skip_packages>
- org.apache.accumulo.core.client.impl
- org.apache.accumulo.core.client.lexicoders.impl
- org.apache.accumulo.core.client.mapred.impl
- org.apache.accumulo.core.client.mapreduce.impl
- org.apache.accumulo.core.client.mapreduce.lib.impl
- org.apache.accumulo.core.client.mock.impl
- org.apache.accumulo.core.data.impl
- org.apache.accumulo.core.data.thrift
- org.apache.accumulo.core.security.crypto
- org.apache.accumulo.core.security.thrift
- org.apache.accumulo.minicluster.impl
+ org.apache.accumulo.core.clientImpl
+ org.apache.accumulo.core.clientImpl.lexicoder
+ org.apache.accumulo.core.clientImpl.mapred
+ org.apache.accumulo.core.clientImpl.mapreduce
+ org.apache.accumulo.core.clientImpl.mapreduce.lib
+ org.apache.accumulo.core.dataImpl
+ org.apache.accumulo.core.dataImpl.thrift
+ org.apache.accumulo.core.securityImpl
+ org.apache.accumulo.core.securityImpl.thrift
+ org.apache.accumulo.miniclusterImpl
</skip_packages>
