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

Update manual with subsection for WPI results #6209

Merged
merged 4 commits into from
Sep 29, 2023
Merged
Changes from 3 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
32 changes: 28 additions & 4 deletions docs/manual/inference.tex
Original file line number Diff line number Diff line change
Expand Up @@ -139,10 +139,9 @@
\end{Verbatim}

The result is a set of log files placed in the \<dljc-out/> folder of the
target project. The results of type-checking with each candidate set of
annotations will be concatenated into the file \<dljc-out/wpi-stdout.log>; the final
results (i.e., those obtained using the most precise, consistent set of annotations)
will appear at the end of this file.
target project.
See Section~\ref{wpi-results} for an explanation of the log files generated by
an invocation of \<wpi.sh>.
The inferred annotations appear in \<.ajava> files in a
temporary directory whose name appears in the \<dlcj-out/wpi-stdout.log> file;
you can find their location by examining the \<-Aajava> argument
Expand Down Expand Up @@ -229,6 +228,31 @@

You may need to wait a few minutes for the command to complete.

\subsectionAndLabel{Whole-program inference results}{wpi-results}

The result of invoking \<wpi.sh> are log files stored in the \<dljc-out/> folder
of the target project.
The \<dljc-out/> folder contains:

\begin{itemize}
jyoo980 marked this conversation as resolved.
Show resolved Hide resolved
\item \<build\_output.txt>: Logs collected from compiling the target project
jyoo980 marked this conversation as resolved.
Show resolved Hide resolved
using the build file found at the top-level directory.
\item \<javac.json>: The list of all `.java` files for which inference was
attempted by \<wpi.sh>, and the options passed to \<javac>.
\item \<stats.json>: Statistics from the invocation of \<wpi.sh> on the target
project, including build time, the number of built \<.jar> files, the number of
executable \<.jar> files, the number of \<javac> invocations, and the number of
source files.
\item \<typecheck.out>: The final results of type-checking obtained with the
jyoo980 marked this conversation as resolved.
Show resolved Hide resolved
latest iteration of WPI (i.e., the most precise, consistent set of
jyoo980 marked this conversation as resolved.
Show resolved Hide resolved
annotations).
\item \<wpi-stdout.log>: The results of type-checking with each candidate set of
annotations.
jyoo980 marked this conversation as resolved.
Show resolved Hide resolved
The final results (i.e., those obtained using the most precise, consistent
set of annotations) will appear at the end of this file.
\item \<toplevel.log>: The log of the command executed at the top-level of the
target directory to invoke whole-program inference.
\end{itemize}

\subsectionAndLabel{Requirements for whole-program inference scripts}{wpi-shared-requirements}

Expand Down