From 016caec3400591af5c9ab3885258a02cdf35ef70 Mon Sep 17 00:00:00 2001 From: Michael Ernst Date: Tue, 3 Dec 2024 10:51:01 -0800 Subject: [PATCH] There is no need to build the annotated JDK --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 22bff8194e912..820e18068d329 100644 --- a/README.md +++ b/README.md @@ -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): @@ -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