diff options
| author | Julien Eluard <[email protected]> | 2011-02-04 10:40:02 -0800 |
|---|---|---|
| committer | Julien Eluard <[email protected]> | 2011-02-04 10:40:02 -0800 |
| commit | c6e346ae20a50ac3d29f9457b00ca8b4ca97bec7 (patch) | |
| tree | 04b4d92757a726ea5f45972b837de7f4e42b2672 | |
| parent | 94a8f7314607e7f4e9f5b5e207aa99e16f8d089e (diff) | |
Updated documentation.
29 files changed, 9 insertions, 5 deletions
diff --git a/.gitignore b/.gitignore index 2f7896d..2f7896d 100644..100755 --- a/.gitignore +++ b/.gitignore diff --git a/README.textile b/README.textile index 19c51f7..19c51f7 100644..100755 --- a/README.textile +++ b/README.textile diff --git a/api/pom.xml b/api/pom.xml index 47a846f..47a846f 100644..100755 --- a/api/pom.xml +++ b/api/pom.xml diff --git a/api/src/main/java/org/semver/Comparer.java b/api/src/main/java/org/semver/Comparer.java index 57fce7f..57fce7f 100644..100755 --- a/api/src/main/java/org/semver/Comparer.java +++ b/api/src/main/java/org/semver/Comparer.java diff --git a/api/src/main/java/org/semver/Delta.java b/api/src/main/java/org/semver/Delta.java index e856bb2..e856bb2 100644..100755 --- a/api/src/main/java/org/semver/Delta.java +++ b/api/src/main/java/org/semver/Delta.java diff --git a/api/src/main/java/org/semver/Dumper.java b/api/src/main/java/org/semver/Dumper.java index e2dd513..e2dd513 100644..100755 --- a/api/src/main/java/org/semver/Dumper.java +++ b/api/src/main/java/org/semver/Dumper.java diff --git a/api/src/main/java/org/semver/Main.java b/api/src/main/java/org/semver/Main.java index ec2f8e7..ec2f8e7 100644..100755 --- a/api/src/main/java/org/semver/Main.java +++ b/api/src/main/java/org/semver/Main.java diff --git a/api/src/main/java/org/semver/Version.java b/api/src/main/java/org/semver/Version.java index d7b8dbd..d7b8dbd 100644..100755 --- a/api/src/main/java/org/semver/Version.java +++ b/api/src/main/java/org/semver/Version.java diff --git a/api/src/main/java/org/semver/jardiff/DifferenceAccumulatingHandler.java b/api/src/main/java/org/semver/jardiff/DifferenceAccumulatingHandler.java index 5d32424..5d32424 100644..100755 --- a/api/src/main/java/org/semver/jardiff/DifferenceAccumulatingHandler.java +++ b/api/src/main/java/org/semver/jardiff/DifferenceAccumulatingHandler.java diff --git a/api/src/site/apt/index.apt b/api/src/site/apt/index.apt index bd76f26..bd76f26 100644..100755 --- a/api/src/site/apt/index.apt +++ b/api/src/site/apt/index.apt diff --git a/api/src/site/apt/usage.apt.vm b/api/src/site/apt/usage.apt.vm index 0d87e05..a07f7be 100644..100755 --- a/api/src/site/apt/usage.apt.vm +++ b/api/src/site/apt/usage.apt.vm @@ -18,7 +18,7 @@ What is this? - This simple command line tool looks at Java JAR files and determine inspect API changes. + This simple command line tool looks at Java JAR files and determine API changes. You might download self contained JAR file from {{{https://github.com/downloads/jeluard/semantic-versioning/semver-${project.version}.jar}github}}. diff --git a/api/src/site/site.xml b/api/src/site/site.xml index 5934f1a..5934f1a 100644..100755 --- a/api/src/site/site.xml +++ b/api/src/site/site.xml diff --git a/api/src/test/java/org/semver/DeltaTest.java b/api/src/test/java/org/semver/DeltaTest.java index 5e292ec..5e292ec 100644..100755 --- a/api/src/test/java/org/semver/DeltaTest.java +++ b/api/src/test/java/org/semver/DeltaTest.java diff --git a/api/src/test/java/org/semver/VersionTest.java b/api/src/test/java/org/semver/VersionTest.java index 0923c5f..0923c5f 100644..100755 --- a/api/src/test/java/org/semver/VersionTest.java +++ b/api/src/test/java/org/semver/VersionTest.java diff --git a/enforcer-rule/pom.xml b/enforcer-rule/pom.xml index c7bb00a..c7bb00a 100644..100755 --- a/enforcer-rule/pom.xml +++ b/enforcer-rule/pom.xml diff --git a/enforcer-rule/src/main/java/org/semver/enforcer/AbstractEnforcerRule.java b/enforcer-rule/src/main/java/org/semver/enforcer/AbstractEnforcerRule.java index 670a7b0..670a7b0 100644..100755 --- a/enforcer-rule/src/main/java/org/semver/enforcer/AbstractEnforcerRule.java +++ b/enforcer-rule/src/main/java/org/semver/enforcer/AbstractEnforcerRule.java diff --git a/enforcer-rule/src/main/java/org/semver/enforcer/RequireBackwardCompatibility.java b/enforcer-rule/src/main/java/org/semver/enforcer/RequireBackwardCompatibility.java index 57050f7..57050f7 100644..100755 --- a/enforcer-rule/src/main/java/org/semver/enforcer/RequireBackwardCompatibility.java +++ b/enforcer-rule/src/main/java/org/semver/enforcer/RequireBackwardCompatibility.java diff --git a/enforcer-rule/src/main/java/org/semver/enforcer/RequireSemanticVersioningConformance.java b/enforcer-rule/src/main/java/org/semver/enforcer/RequireSemanticVersioningConformance.java index 608557e..608557e 100644..100755 --- a/enforcer-rule/src/main/java/org/semver/enforcer/RequireSemanticVersioningConformance.java +++ b/enforcer-rule/src/main/java/org/semver/enforcer/RequireSemanticVersioningConformance.java diff --git a/enforcer-rule/src/site/apt/examples/backward-compatibility.apt.vm b/enforcer-rule/src/site/apt/examples/backward-compatibility.apt.vm index bfbf818..5251a22 100644..100755 --- a/enforcer-rule/src/site/apt/examples/backward-compatibility.apt.vm +++ b/enforcer-rule/src/site/apt/examples/backward-compatibility.apt.vm @@ -23,7 +23,7 @@ Checking a project's compatibility against older releases In order to check your project's compatibility against an older release, you must add the enforcer rule as a dependency to the maven-enforcer-plugin and then configure your the maven-enforcer-plugin to run the rule. - By default current artifact will be checked against most recently released version (retrieved from either local or one of configured remote repositories). + By default current artifact will be checked against most recently released version (retrieved from either local or one of configured remote repositories). Setting dumpDetails to true will output differences to standard output. --- <project> @@ -58,6 +58,7 @@ Checking a project's compatibility against older releases <rules> <requireBackwardCompatibility implementation="org.semver.enforcer.RequireBackwardCompatibility"> <compatibilityType>BACKWARD_COMPATIBLE_IMPLEMENTER</compatibilityType> + <dumpDetails>true</dumpDetails> </requireBackwardCompatibility> </rules> </configuration> diff --git a/enforcer-rule/src/site/apt/examples/semantic-versioning-conformance.apt.vm b/enforcer-rule/src/site/apt/examples/semantic-versioning-conformance.apt.vm index fdfd7dd..0f7bf82 100644..100755 --- a/enforcer-rule/src/site/apt/examples/semantic-versioning-conformance.apt.vm +++ b/enforcer-rule/src/site/apt/examples/semantic-versioning-conformance.apt.vm @@ -23,7 +23,7 @@ Checking a project's version against older releases In order to check your project's version against an older release, you must add the enforcer rule as a dependency to the maven-enforcer-plugin and then configure your the maven-enforcer-plugin to run the rule. - By default current artifact will be checked against most recently released version (retrieved from either local or one of configured remote repositories). + By default current artifact will be checked against most recently released version (retrieved from either local or one of configured remote repositories). Setting dumpDetails to true will output differences to standard output. --- <project> @@ -56,7 +56,9 @@ Checking a project's version against older releases </goals> <configuration> <rules> - <requireSemanticVersioningConformance implementation="org.semver.enforcer.RequireSemanticVersioningConformance" /> + <requireSemanticVersioningConformance implementation="org.semver.enforcer.RequireSemanticVersioningConformance"> + <dumpDetails>true</dumpDetails> + </requireSemanticVersioningConformance> </rules> </configuration> </execution> diff --git a/enforcer-rule/src/site/apt/index.apt b/enforcer-rule/src/site/apt/index.apt index 2887116..2887116 100644..100755 --- a/enforcer-rule/src/site/apt/index.apt +++ b/enforcer-rule/src/site/apt/index.apt diff --git a/enforcer-rule/src/site/apt/usage.apt.vm b/enforcer-rule/src/site/apt/usage.apt.vm index fc9c196..fc9c196 100644..100755 --- a/enforcer-rule/src/site/apt/usage.apt.vm +++ b/enforcer-rule/src/site/apt/usage.apt.vm diff --git a/enforcer-rule/src/site/site.xml b/enforcer-rule/src/site/site.xml index 6320bdf..d8d264e 100644..100755 --- a/enforcer-rule/src/site/site.xml +++ b/enforcer-rule/src/site/site.xml @@ -27,7 +27,8 @@ <item name="Usage" href="usage.html" /> </menu> <menu name="Examples"> - <item name="Checking a project version number" href="examples/checking-version.html" /> + <item name="Checking a project backward compatibility" href="examples/backward-compatibility.html" /> + <item name="Checking a project version number" href="examples/semantic-versioning-conformance.html" /> </menu> <menu ref="reports" /> </body> diff --git a/licenses/LICENSE.jardiff b/licenses/LICENSE.jardiff index 59b1cea..59b1cea 100644..100755 --- a/licenses/LICENSE.jardiff +++ b/licenses/LICENSE.jardiff diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt index 6e71adc..6e71adc 100644..100755 --- a/src/site/apt/index.apt +++ b/src/site/apt/index.apt diff --git a/src/site/site.xml b/src/site/site.xml index af9db54..af9db54 100644..100755 --- a/src/site/site.xml +++ b/src/site/site.xml |