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 Eclipse configuration & manual chapter #1973

Merged
merged 14 commits into from May 28, 2018
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
42 changes: 0 additions & 42 deletions checker-qual/.classpath

This file was deleted.

23 changes: 0 additions & 23 deletions checker-qual/.project

This file was deleted.

41 changes: 0 additions & 41 deletions checker/.classpath

This file was deleted.

23 changes: 0 additions & 23 deletions checker/.project

This file was deleted.

32 changes: 0 additions & 32 deletions dataflow/.classpath

This file was deleted.

23 changes: 0 additions & 23 deletions dataflow/.project

This file was deleted.

22 changes: 14 additions & 8 deletions docs/manual/troubleshooting.tex
Expand Up @@ -993,15 +993,21 @@ \subsection{Configure Eclipse to edit the Checker Framework\label{building-eclip
\item Download Eclipse from
the \href{https://www.eclipse.org/downloads/}{official Eclipse website}
and install it.
\item Run Eclipse and set the
workspace to the directory pointed to by \code{\$JSR308}.
\item Run Eclipse.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One still needs to perform the normal Import Projects for jsr308-langtools, annotation-tools, etc.
Or how does Eclipse find the source code for these projects?
Can you split these instructions up into the old-style part that will remain as before, and the new part that works for the Gradle projects, which is just the checker-framework directory.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Gradle imports configure the CF subprojects to depend on stubparser.jar, AFU.jar, and compiler-2.4.0.jar so they don't directly depend on jsr308-langtools, annotation-tools, etc.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do these jar files contain source files?
For development it's very helpful to actually see the javadoc for compiler methods.
Also, should the first bullet point be updated? It currently says "clone and build all projects from their sources".
Maybe this should now only clone checker-framework?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the jars don't contain the source files.

I've updated the set of eclipse project and classpath files instead and cleaned up the manual instructions on what projects to not select.

\item Enter the main Eclipse working screen and in the ``File'' menu,
select ``Import'' $\rightarrow$ ``General'' $\rightarrow$ ``Existing
Projects into workspace''.
\item After the ``Import Projects'' window appears, select ``Select
Root Directory'', and select the directory pointed to by \code{\$JSR308}.
\item Select all the projects in the folder except for the ones
related to ``Eclipse'', ``encryption'', ``tutorial'', and ``demo''.
select ``Import'' $\rightarrow$ ``Gradle'' $\rightarrow$ ``Existing
Gradle Project''.
\item After the ``Import Gradle Project'' window appears, select ``Browse'',
and select the directory pointed to by \code{\$JSR308/checker-framework}.
\item Select "Finish". The checker-framework project and its subprojects
should now appear in the "Package Explorer" panel.
\item Wait until Eclipse finishes building the workspace, then in the
``Package Explorer'' panel, right click on the \code{util} project and select
``Properties''.
\item Select ``Java Build Path'' $\rightarrow$ ``Libraries'' $\rightarrow$
``Add External JARs'', and add \code{tools.jar} within the \code{lib}
folder of your JDK 8 installation to the list of library dependencies.
Once added, select ``Apply and Close''.
\end{enumerate}
Eclipse should successfully build all the imported projects.
If Eclipse reports any errors, ensure you followed the instructions
Expand Down
40 changes: 0 additions & 40 deletions framework/.classpath

This file was deleted.

23 changes: 0 additions & 23 deletions framework/.project

This file was deleted.

31 changes: 0 additions & 31 deletions javacutil/.classpath

This file was deleted.

23 changes: 0 additions & 23 deletions javacutil/.project

This file was deleted.