Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

There is no need to build the annotated JDK #223

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
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
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Typetools fork of the JDK

This fork of the JDK contains type annotations for pluggable type-checking.
It is called "the annotated JDK".

It does *not* contain annotations for certain files (because annotations in
them cause build failures, especially in the interim builds):
Expand All @@ -16,7 +17,19 @@ https://github.com/typetools/checker-framework/ .

## Building

See file `azure-pipelines.yml`. Briefly:
You **do not need to build** the annotated JDK in order to use it in the Checker
Framework.

Put the annotated JDK is in a directory named `jdk/` that is a sibling of your
`checker-framework/` directory. Now, when you build the Checker Framework
(e.g., `cd checker-framework && ./gradlew assemble`), it will automatically
incorporate the annotated JDK into the resulting Checker Framework binaries.
The `jdk/` and `checker-framework/` directories can be clones of the relevant
repositories, or they can be (hard or soft) symbolic links to the clones.

However, if for some reason you want to build the JDK on its own rather than
just use it from the Checker Framework, see file `azure-pipelines.yml`.
Briefly:

```
bash configure --disable-warnings-as-errors --with-jtreg
Expand Down
Loading