Update Eclipse configuration & manual chapter #1973

jyluo · 2018-05-07T01:37:13Z

This PR updates the Configure Eclipse to edit the Checker Framework chapter of the manual, and updates the set of eclipse .project and .classpath files.

The eclipse project files are modified to be plain Java projects, and outputs compiled class files to the build/classes/java directory. This change makes the compiled output directory consistent with Gradle, and allows the updated bin-devel/javac script to work with eclipse generated outputs, as the script only examines class files in build/classes/java.

…f the manual to import the CF projects as gradle projects in eclipse. Also removed are the old `.project` and `.classpath` files in the projects.

wmdietl

Thanks for working on this!

wmdietl · 2018-05-07T19:47:50Z

docs/manual/troubleshooting.tex

@@ -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.


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.

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.

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?

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.

…4.12

CharlesZ-Chen · 2018-05-15T18:59:11Z

Hi Jeff @jyluo, I just tried your branch and here are what I got:

steps:

Fetch CF from jyluo:update_eclipse_editor_chapter.

Build CF by running .travis-build-without-test.sh, which should produce the same build result as the one following the section "build from source".

Follow the update latex section to import CF, this step I meet two problems:

Ensure ``Search for nested projects'' is selected in the Options panel.

When I enable this option, I will got two stubparpser projects (one in CF/stubparser/bin and the other one in CF/stubparser/bin/bin). Then Eclipse will stop me from trying to import duplicate projects. However, if I didn't enable this option, the project imports works without any warning.
After I imported all required projects, I still got two missing dependencies errors: jsr308-langtools and scene-lib are missing.

Any ideas? Is there anything I did wrong?

Update:

Ok, I found the reason. This PR updates the .classpath files of checker and framework projects, requiring jsr308-langtools and scene-lib as their dependencies. It would be good to reflect this requirement in the corresponding latex section, to require users also need to import scence-lib and asmx (depedency for scence-lib) from AFU, and jsr308-langtools.

Update2:

Following steps make me successfully import CF related projects into my eclipse:

Clone CF
Build CF
Import all projects (not enable nested-project option) from CF except the personal-blog
Import scence-lib and asmx from directory annotation-tools
Import jsr308-langtools form directory jsr308-langtools
This step is weird: at this point, it should be supposed to work. However, eclipse still complain about: "Missing jars for project scence-lib: guava-20.0.jar, options-all-0.3.1.jar, and plume-util-0.0.1.jar". I have to right click on the project scence-lib in my eclipse, then go to build path -> configure build path..., then re-select the locations of these jars again from AFU/lib.

Then finally all projects build in my eclipse.

jyluo · 2018-05-15T21:10:13Z

@CharlesZ-Chen can you point the root directory to $JSR308 and then import with the nested project option? Separately importing scene-lib, asmx, and jsr308-langtools should be unnecessary if $JSR308 is selected as the root.

As for stubparser/bin and stubparser/bin/bin I'll investigate, but it should be a clean up of those projects, not this import instruction.

jyluo · 2018-05-15T21:22:55Z

@CharlesZ-Chen

This step is weird: at this point, it should be supposed to work. However, eclipse still complain about: "Missing jars for project scence-lib: guava-20.0.jar, options-all-0.3.1.jar, and plume-util-0.0.1.jar". I have to right click on the project scence-lib in my eclipse, then go to build path -> configure build path..., then re-select the locations of these jars again from AFU/lib.

You don't have to re-point those jars if you also import AFU itself as a project, hence setting $JSR308 as the root of the import with nested-project scan to pick up AFU, scene-lib, & asmx.

jyluo · 2018-05-16T17:20:40Z

Remove junit jar here and file an update to AFU/lib

… into update_eclipse_editor_chapter

wmdietl

One more question, then we can merge this.

wmdietl · 2018-05-24T19:22:01Z

checker-qual/.classpath

-			<attribute name="gradle_used_by_scope" value="compatQual"/>
-		</attributes>
-	</classpathentry>
+	<classpathentry kind="src" output="build/classes/java/main" path="src/main/java"/>


Should we remove the checker-qual files .project and .classpath?
They duplicate files that are in checker, e.g. when I look up NullnessType I see two matches.
The "real" location is in checker, so do we need to integrate this directory at all?

So I tried doing this and then run into cyclic dependency problems.
So as alternative, can we use checker-qual as binary dependency but use the source code from checker?

I've changed it to depend on checker-qual.jar and removed the .project and .classpath from checker-qual project.

wmdietl · 2018-05-24T20:53:31Z

checker/.classpath

 	<classpathentry kind="src" path="/javacutil"/>
-	<classpathentry kind="src" path="/checker-qual"/>
+	<classpathentry kind="src" path="/jsr308-langtools"/>


One more thing: at the moment every project depends on the other projects. It would be nicer if e.g. checker didn't need to depend on jsr308-langtools and dataflow directly, because it got that dependency from framework.
In the IDE, in the "Java Build Path" under "Order and Export" you can export the packages and thereby make these dependencies more implicit.

…e project for jdk8

Updates the Configure Eclipse to edit the Checker Framework chapter o…

1252857

…f the manual to import the CF projects as gradle projects in eclipse. Also removed are the old `.project` and `.classpath` files in the projects.

smillst assigned wmdietl May 7, 2018

wmdietl requested changes May 7, 2018

View reviewed changes

wmdietl assigned jyluo and unassigned wmdietl May 7, 2018

jyluo added 4 commits May 8, 2018 15:51

add updated set of eclipse projects and classpaths

cb053d9

update manual

3ab4b08

reorder and clean up projects and classpaths [ci skip]

ebfa051

add junit-4.12.jar to util as it depends on new functions in version …

c13d4a3

…4.12

jyluo added 5 commits May 23, 2018 23:40

switch eclipse build output classpaths from bin/ to build/

4238233

remove junit-4.12 binary & use eclipse's junit library

399428b

Merge branch 'master' of https://github.com/typetools/checker-framework…

b372de9

… into update_eclipse_editor_chapter

clean up

c37000b

update jdk8 project output folder

21178c6

wmdietl reviewed May 24, 2018

View reviewed changes

wmdietl changed the title ~~Update "Configure Eclipse to edit the Checker Framework" manual chapter~~ Update Eclipse configuration & manual chapter May 24, 2018

jyluo added 2 commits May 24, 2018 16:11

switch checker-qual to a jar dependency as per feedback

6e8eada

attach sourcepath

64a5991

wmdietl reviewed May 24, 2018

View reviewed changes

jyluo added 2 commits May 25, 2018 00:22

update classpath implicit dependencies, and remove unnecessary eclips…

430ba57

…e project for jdk8

fully minimize direct dependencies

e832f6a

wmdietl approved these changes May 28, 2018

View reviewed changes

wmdietl merged commit 09804f7 into typetools:master May 28, 2018

jyluo deleted the update_eclipse_editor_chapter branch May 30, 2018 03:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Eclipse configuration & manual chapter #1973

Update Eclipse configuration & manual chapter #1973

jyluo commented May 7, 2018 •

edited

wmdietl left a comment

wmdietl May 7, 2018

jyluo May 7, 2018

wmdietl May 7, 2018

jyluo May 8, 2018

CharlesZ-Chen commented May 15, 2018 •

edited

jyluo commented May 15, 2018 •

edited

jyluo commented May 15, 2018

jyluo commented May 16, 2018

wmdietl left a comment

wmdietl May 24, 2018

wmdietl May 24, 2018

jyluo May 24, 2018

wmdietl May 24, 2018

Update Eclipse configuration & manual chapter #1973

Update Eclipse configuration & manual chapter #1973

Conversation

jyluo commented May 7, 2018 • edited

wmdietl left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CharlesZ-Chen commented May 15, 2018 • edited

jyluo commented May 15, 2018 • edited

jyluo commented May 15, 2018

jyluo commented May 16, 2018

wmdietl left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jyluo commented May 7, 2018 •

edited

CharlesZ-Chen commented May 15, 2018 •

edited

jyluo commented May 15, 2018 •

edited