aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJulien Eluard <[email protected]>2013-12-17 05:55:29 -0800
committerJulien Eluard <[email protected]>2013-12-17 05:55:29 -0800
commit82add49bc695e5d46512cd52dc98e889763298f1 (patch)
tree86ef8e478e51f0731352163562e04dc806153625 /README.md
parentf89c0a958b01ae732ac16c1dfdae15a9715f735a (diff)
parent6be976ede44ea70e9d8317d33c35cef147bb63c1 (diff)
Merge pull request #15 from LarsSommer/master
Merging of enhancement of excluding and including classes. Closes #7.
Diffstat (limited to 'README.md')
-rwxr-xr-xREADME.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index f01a9a6..969ea64 100755
--- a/README.md
+++ b/README.md
@@ -56,9 +56,11 @@ Options:
--check,-c Check the compatibility of two jars.
--diff,-d Show the differences between two jars.
--excludes EXCLUDE;... Semicolon separated list of full qualified class names
+ or partly qualified class names with wild cards
to be excluded.
--help,-h Show this help and exit.
--includes INCLUDE;... Semicolon separated list of full qualified class names
+ or partly qualified class names with wild cards
to be included.
--infer,-i Infer the version of the new jar based on the previous
jar.
@@ -82,6 +84,19 @@ Class org.project.MyClass2
Changed Field field2 removed: final
```
+### Excludes / Includes
+
+In- or exclude classes for the validation by specifying a fully qualified
+class name or using wild cards. There are two wild cards: `*` and `**`.
+`*` is a wild card for an arbitrary number of characters but at most one
+folder hierarchy.
+`**` is a wild card for an arbitrary number of characters and an arbitrary
+number of folder hierarchies.
+
+```
+% java -jar semver.jar --excludes **/MyClass; org/**/MyClass; org/**/*Class;
+```
+
### Check
Check compatibility type between two JARs.