Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ defined by a series of options similar to those supported by `javac`.

* _[Daisy Diff]_: an HTML comparison library, required when building `apidiff`
* _[Java Diff Utils]_: a plain-text comparison library, required when building `apidiff`
* _[TestNG]_: the testing framework, used to run some of the tests for `apidiff`
* _[JUnit]_: the testing framework, used to run some of the tests for `apidiff`

Suitable versions of these dependencies can be downloaded by running
`make/build.sh`.
Expand Down Expand Up @@ -39,12 +39,12 @@ unless these values have been overridden on the command line used to run `make`.
An IDE such as IntelliJ IDEA needs the following configuration:

* Sources Root: `src`
* TestNG Test Root: `test/testng`
* JUnit Test Root: `test/junit`
* Libraries:
* _Daisy Diff_, _Java Diff Utils_ available for compilation
* _TestNG_ available for testing
* _Daisy Diff_, _HTMLCleaner_, _Java Diff Utils_ available for compilation
* _JUnit_ available for testing

In addition, some TestNG tests require access to internal classes in
In addition, some JUnit tests require access to internal classes in
the `jdk.compiler` and `jdk.jdeps` modules:

````
Expand Down Expand Up @@ -80,4 +80,4 @@ parts of those files that will be compared by `apidiff`.

[Daisy Diff]: https://github.com/DaisyDiff/DaisyDiff
[Java Diff Utils]: https://github.com/java-diff-utils/java-diff-utils
[TestNG]: https://testng.org/
[JUnit]: https://junit.org/
23 changes: 13 additions & 10 deletions make/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ _apidiff_ has various external dependencies:

* _JDK_: must be at least JDK 17
* _Java Diff Utils_
* _HtmlCleaner_
* _Daisy Diff_
* _JUnit_ (for testing only)

Expand Down Expand Up @@ -44,7 +45,9 @@ The makefile provides the following targets:
* `build`: build _apidiff_

Requires the following to be set:
`JDKHOME`, `JAVA_DIFF_UTILS_JAR`, `JAVA_DIFF_UTILS_LICENSE`, `DAISYDIFF_JAR`, `DAISYDIFF_LICENSE`.
`JDKHOME`, `JAVA_DIFF_UTILS_JAR`, `JAVA_DIFF_UTILS_LICENSE`,
`DAISYDIFF_JAR`, `DAISYDIFF_LICENSE`,
`HTMLCLEANER_JAR`, `HTMLCLEANER_LICENSE`.

* `test`: run tests

Expand All @@ -66,12 +69,12 @@ The makefile provides the following targets:

## File Locations

| Files | GNU Make | Ant | IntelliJ |
|----------------------|-----------------------------------|-----------------------------------------|-------------------|
| Default Dependencies | build/deps | build/deps | build/deps |
| Main Classes | build/classes | build/classes | out/production |
| Test Classes | build/TestNGTests/classes | build/test/classes | out/test |
| Test Work | build/TestNGTests/work | build/test/work | build/test/work |
| Test Report | build/TestNGTests/report | build/test/report | |
| Image | build/images/apidiff | dist/apidiff | |
| Bundle | build/images/apidiff.zip | dist/apidiff.zip | |
| Files | GNU Make | Ant | IntelliJ |
|----------------------|--------------------------|--------------------|-------------------|
| Default Dependencies | build/deps | build/deps | build/deps |
| Main Classes | build/classes | build/classes | out/production |
| Test Classes | build/JUnitTests/classes | build/test/classes | out/test |
| Test Work | build/JUnitTests/work | build/test/work | build/test/work |
| Test Report | build/JUnitTests/report | build/test/report | |
| Image | build/images/apidiff | dist/apidiff | |
| Bundle | build/images/apidiff.zip | dist/apidiff.zip | |