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.

Sign up for GitHub

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

Improve Maven instructions. Fixes #5086. #5089

Merged
merged 4 commits into from
Mar 24, 2022
Merged

Improve Maven instructions. Fixes #5086. #5089

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9e4c766
Improve Maven instructions. Fixes #5086.
mernst Mar 21, 2022
6b826e7
Comment out wrong instructions
mernst Mar 21, 2022
decc419
Tweak
mernst Mar 21, 2022
dd6c2f7
Remove unbalanced quote mark
mernst Mar 21, 2022
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
21 changes: 13 additions & 8 deletions docs/manual/external-tools.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -973,18 +973,17 @@
</dependencies>
\end{alltt}

Java 11 and later do not need the \<com.google.errorprone.javac>
Java 11 and later do not need the \<com.google.errorprone:javac>
dependency. If you will never use Java 8, you can omit it.
The need for the \<com.google.errorprone:javac> artifact when running under
JDK 8 is explained in Section~\ref{javac-jdk8}.

Periodically update to the most recent version, to obtain the
latest bug fixes and new features:
\begin{Verbatim}
mvn versions:use-latest-versions -Dincludes="org.checkerframework:*"
\end{Verbatim}

The need for the \<com.google.errorprone:javac> artifact when running under
JDK 8 is explained in Section~\ref{javac-jdk8}.

\end{enumerate}

\item If using JDK 8, use a Maven property to hold the location of the
Expand Down Expand Up @@ -1021,8 +1020,9 @@
\item Direct the Maven compiler plugin to use the desired checkers by
creating three new profiles as shown below (the example uses the Nullness
Checker). If your POM file does not already use the
\code{maven-compiler-plugin} plugin, you are done. If your POM file
already uses the plugin, copy edit the first profile to incorporate the
\code{maven-compiler-plugin} plugin, you can use the text below as is.
If your POM file
already uses the plugin, copy and edit the first profile to incorporate the
existing configuration.

%% TODO: Is this comment still accurate?
Expand Down Expand Up @@ -1145,7 +1145,7 @@
\end{mysmall}

Now, building with Maven will run the checkers during every compilation
that uses JDK 8 or JDK 11.
that uses JDK 8 or higher.

If you wish to run checkers while compiling your source code but not your
tests, wrap the \code{<configuration>...</configuration>} within
Expand All @@ -1160,8 +1160,13 @@
\end{Verbatim}

To compile without using the Checker Framework, pass
\<-P '!checkerframework-java11'> (or \<-P '!checkerframework-java8'>)
\<-P !checkerframework>
on the Maven command line.
%% Per GitHub user danibs in
%% https://github.com/typetools/checker-framework/issues/5086,
%% this does not seem to work.
% It should also work to pass
% \<-P !checkerframework-jdk9orlater> or \<-P !checkerframework-java8>.

% TODO: Figure out why, and then remove this paragraph.
Warning: adding
Expand Down